v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB

connections

Update Connection

Updates a connections metadata or mode. These changes will be seen after the next sync.

put/connections/{connection_id}

Path parameters

connection_idstring uuid required

Request body

metadataobject

Metadata for the document. Keys must be strings. Values may be strings, numbers, booleans, or lists of strings. Numbers may be integers or floating point and will be converted to 64 bit floating point. 1000 total values are allowed. Each item in an array counts towards the total. The following keys are reserved for internal use: document_id, document_type, document_source, document_name, document_uploaded_at, start_time, end_time, chunk_content_type.

sync_filterSyncFilter

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