Update Source Connection

Update an existing source connection’s configuration

PATCH /v1/source-connections/{id}

Update Source Connection

cURL

curl --request PATCH \
  --url https://api.example.com/v1/source-connections/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "config": {},
  "schedule": {
    "cron": "<string>",
    "continuous": true,
    "cursor_field": "<string>"
  },
  "authentication": {
    "credentials": {}
  }
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "modified_at": "<string>"
}

Overview

Update a 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.

Path Parameters

id · string · required

Unique UUID identifier of the source connection to update

Example: “550e8400-e29b-41d4-a716-446655440000”

Request Body

All fields are optional. Only include fields you want to change.

name · string

Updated display name for the connection (4-42 characters)

description · string

Updated description (max 255 characters)

config · object

Updated source-specific configuration

Example: {"repo_name": "company/new-repo", "branch": "develop"}

schedule · object

Updated sync schedule configuration

Show properties

cron · string

Cron expression for scheduled syncs

continuous · boolean

Enable continuous sync mode

cursor_field · string

Field for incremental sync

authentication · object

Updated authentication credentials (direct auth only)

Show properties

credentials · object

Updated authentication credentials

Response

Returns the updated source connection object.

id · string · required

UUID of the connection

name · string · required

Updated display name

modified_at · string · required

ISO 8601 timestamp when last modified

Example Request

cURL

curl -X PATCH https://api.airweave.ai/v1/source-connections/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production GitHub Repo",
    "config": {
      "repo_name": "company/new-repo",
      "branch": "main"
    }
  }'

Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production GitHub Repo",
  "description": "Main documentation repository",
  "short_name": "github",
  "readable_collection_id": "documentation-ab123",
  "status": "ACTIVE",
  "created_at": "2024-03-15T09:30:00Z",
  "modified_at": "2024-03-15T16:45:00Z",
  "auth": {
    "method": "direct",
    "authenticated": true
  },
  "config": {
    "repo_name": "company/new-repo",
    "branch": "main"
  }
}

Error Responses

404 Not Found

Source connection with the specified ID does not exist

422 Validation Error

Invalid request body