Sign in
connections

Set Connection Limits

Sets limits on a connection. Limits can be set on the total number of pages a connection can sync. When the limit is reached, the connection will be disabled. Limit may be removed by setting it to null.

put/connections/{connection_id}/limit

Path parameters

connection_idstring uuid required

Request body

page_limitinteger nullable

The maximum number of pages a connection will sync. The connection will be disabled after this limit is reached. Some in process documents may continue processing. Remove the limit by setting to null.

Example request

{
  "page_limit": 1000
}

Response

Successful Response

idstring uuid required
created_atstring date-time required
updated_atstring date-time required
metadataobject required
typestring required
namestring required
enabledboolean required
disabled_by_system_reason'connection_over_total_page_limit' | 'authentication_failed' | 'tenant_account_disabled' nullable required
last_synced_atstring date-time nullable
syncingboolean nullable
partitionstring nullable
page_limitinteger nullable required
sync_filterSyncFilter required
disabled_by_systemboolean required

Changes

No recorded changes to this endpoint across all 1 revision of this API.