Update Source Connection

import requests
url = "https://api.airweave.ai/source-connections/550e8400-e29b-41d4-a716-446655440000"
payload = {}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "GitHub Docs Repo",
  "short_name": "github",
  "readable_collection_id": "documentation-ab123",
  "status": "active",
  "created_at": "2024-03-15T09:30:00Z",
  "modified_at": "2024-03-15T14:22:15Z",
  "auth": {
    "method": "direct",
    "authenticated": true,
    "authenticated_at": "2024-03-15T09:30:00Z"
  },
  "description": "Main documentation repository",
  "config": {
    "branch": "main",
    "repo_name": "company/docs"
  },
  "schedule": {
    "cron": "0 */6 * * *",
    "next_run": "2024-03-15T18:00:00Z"
  },
  "sync": {
    "total_runs": 15,
    "successful_runs": 14,
    "failed_runs": 1,
    "last_job": {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "status": "created",
      "started_at": "2024-03-15T12:00:00Z",
      "completed_at": "2024-03-15T12:05:32Z",
      "duration_seconds": 332,
      "entities_inserted": 45,
      "entities_updated": 12
    }
  },
  "entities": {
    "total_entities": 1250,
    "by_type": {
      "file": {
        "count": 1250
      }
    }
  },
  "federated_search": false
}

Update an existing source connection’s configuration.

You can modify:

Name and description: Display information
Configuration: Source-specific settings (e.g., repository name, filters)
Schedule: Cron expression for automatic syncs
Authentication: Update credentials (direct auth only)

Only include the fields you want to change; omitted fields retain their current values.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

source_connection_idstringRequiredformat: "uuid"

Unique identifier of the source connection to update (UUID)

Request

This endpoint expects an object.

namestring or nullOptional4-42 characters

Updated display name for the connection

descriptionstring or nullOptional<=255 characters

Updated description

configmap from strings to any or nullOptional

Updated source-specific configuration

scheduleobject or nullOptional

Updated sync schedule configuration

authenticationobject or nullOptional

Updated authentication credentials (direct auth only)

Response

Updated source connection

idstringformat: "uuid"

Unique identifier of the source connection

organization_idstringformat: "uuid"

Organization this connection belongs to

namestring

Display name of the connection

short_namestring

Source type identifier

readable_collection_idstring

Collection this connection belongs to

statusenum

Current operational status of the connection

created_atstringformat: "date-time"

When the connection was created (ISO 8601)

modified_atstringformat: "date-time"

When the connection was last modified (ISO 8601)

authobject

Authentication status and details

descriptionstring or nullOptional

Optional description of the connection's purpose

configmap from strings to any or nullOptional

Source-specific configuration values

scheduleobject or nullOptional

Sync schedule configuration

syncobject or nullOptional

Sync execution history and statistics

sync_idstring or nullOptionalformat: "uuid"

ID of the associated sync (internal use)

entitiesobject or nullOptional

Summary of synced entities by type

error_categoryenum or nullOptional

Error category when status is needs_reauth (e.g. oauth_credentials_expired)

error_messagestring or nullOptional

Human-readable error message when status is needs_reauth

provider_settings_urlstring or nullOptional

URL to the auth provider's settings dashboard (for auth_provider errors)

provider_short_namestring or nullOptional

Auth provider short_name (e.g. 'composio', 'pipedream') for display

federated_searchbooleanOptionalDefaults to false

Whether this source uses federated (real-time) search instead of syncing

Errors

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error