API ReferenceSource Connections

Update Source Connection

Update a source connection’s properties.

Modify the configuration of an existing source connection including its name, authentication credentials, configuration fields, sync schedule, or source-specific settings.

Path parameters

source_connection_idstringRequiredformat: "uuid"
The unique identifier of the source connection to update

Headers

x-api-keystringRequired

Request

This endpoint expects an object.
namestring or nullOptional>=4 characters<=42 characters
Updated name for the source connection. Must be between 4 and 42 characters.
descriptionstring or nullOptional
Updated description of what this source connection provides.
auth_fieldsobject or string or nullOptional
Updated authentication credentials for the data source. Provide new credentials to refresh or update authentication.
config_fieldsobject or nullOptional

Source-specific configuration parameters required for data extraction. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example Github) to see what is required.

cron_schedulestring or nullOptional
Updated cron expression for automatic synchronization schedule. Set to null to disable automatic syncing.
connection_idstring or nullOptionalformat: "uuid"
Internal connection identifier. This is typically managed automatically and should not be modified manually.
white_label_idstring or nullOptionalformat: "uuid"
ID of the white label integration. Used for custom OAuth integrations with your own branding.
auth_providerstring or nullOptional
Updated auth provider readable ID. Only relevant if the connection uses an auth provider.
auth_provider_configmap from strings to any or nullOptional
Updated configuration for the auth provider. Only relevant if the connection uses an auth provider.

Response

Successful Response
namestring>=1 character<=64 characters

Human-readable display name for the source connection. This helps you identify the connection in the UI and should clearly describe what data it connects to (e.g., ‘Production Stripe Account’, ‘Customer Support Database’).

short_namestring

Technical identifier of the source type (e.g., ‘github’, ‘stripe’, ‘postgresql’, ‘slack’). This determines which connector Airweave uses to sync data.

idstringformat: "uuid"
Unique system identifier for this source connection. This UUID is generated automatically and used for API operations.
organization_idstringformat: "uuid"
Identifier of the organization that owns this source connection. Source connections are isolated per organization.
created_atstringformat: "date-time"

Timestamp when the source connection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the source connection was last modified (ISO 8601 format).

collectionstring
Readable ID of the collection where this source connection syncs its data. This creates the link between your data source and searchable content.
descriptionstring or null<=255 characters
Optional additional context about the data this connection provides. Use this to document the purpose, data types, or any special considerations for this connection.
config_fieldsobject or null

Source-specific configuration options that control data retrieval behavior. These vary by source type and control how data is retrieved (e.g., database queries, API filters, file paths). Check the documentation of a specific source (for example Github) to see what is required.

white_label_idstring or nullformat: "uuid"
Identifier for custom OAuth integrations. Only present for connections created through white label OAuth flows.
auth_providerstring or null
Readable ID of the auth provider used to create this connection. Present only if the connection was created through an auth provider.
auth_provider_configmap from strings to any or null
Configuration used with the auth provider to create this connection. Present only if the connection was created through an auth provider.
sync_idstring or nullformat: "uuid"
Internal identifier for the sync configuration associated with this source connection. Managed automatically by the system.
connection_idstring or nullformat: "uuid"
Internal identifier for the underlying connection object that manages authentication and configuration.
created_by_emailstring or nullformat: "email"
Email address of the user who created this source connection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this source connection.
auth_fieldsobject or string or null

Authentication credentials for the data source. Returns ’********’ by default for security.

statusenum or null

Current operational status of the source connection:
• active: Connection is healthy and ready for data synchronization
• in_progress: Currently syncing data from the source
• failing: Recent sync attempts have failed and require attention

Allowed values:
latest_sync_job_statusenum or null

Status of the most recent data synchronization job:
• completed: Last sync finished successfully
• failed: Last sync encountered errors
• in_progress: Currently running a sync job
• pending: Sync job is queued and waiting to start

latest_sync_job_idstring or nullformat: "uuid"
Unique identifier of the most recent sync job. Use this to track sync progress or retrieve detailed job information.
latest_sync_job_started_atstring or nullformat: "date-time"

Timestamp when the most recent sync job started (ISO 8601 format).

latest_sync_job_completed_atstring or nullformat: "date-time"

Timestamp when the most recent sync job completed (ISO 8601 format). Null if the job is still running or failed.

latest_sync_job_errorstring or null
Error message from the most recent sync job if it failed. Use this to diagnose and resolve sync issues.
cron_schedulestring or null
Cron expression defining when automatic data synchronization occurs. Null if automatic syncing is disabled and syncs must be triggered manually.
next_scheduled_runstring or nullformat: "date-time"

Timestamp when the next automatic sync is scheduled to run (ISO 8601 format). Null if no automatic schedule is configured.

Errors