API ReferenceSource Connections

Update

Update a source connection. Updateable fields: - name, description - config_fields - cron_schedule - auth_fields (direct auth only)

Authentication

x-api-keystring
API Key authentication via header

Path Parameters

source_connection_idstringRequiredformat: "uuid"

Headers

X-Framework-NamestringOptional
X-Framework-VersionstringOptional

Request

This endpoint expects an object.
namestring or nullOptional4-42 characters
descriptionstring or nullOptional<=255 characters
configmap from strings to any or nullOptional

Source-specific configuration

scheduleobject or nullOptional
Schedule configuration for syncs.
authenticationobject or nullOptional

Authentication config (defaults to OAuth browser flow for OAuth sources)

Response

Successful Response
idstringformat: "uuid"
namestring
descriptionstring or null
short_namestring
readable_collection_idstring
statusenum

Source connection status enum - represents overall connection state.

created_atstringformat: "date-time"
modified_atstringformat: "date-time"
authobject
Authentication information.
configmap from strings to any or null
scheduleobject or null
Schedule information.
syncobject or null
Sync execution details.
sync_idstring or nullformat: "uuid"
ID of the associated sync
entitiesobject or null
Entity state summary.

Errors