Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB
source-connections

Delete Source Connection

Permanently delete a source connection and all its synced data.

What happens when you delete:

  1. Any running sync is cancelled and the API waits (up to 15 s) for the worker to stop writing.
  2. The source connection, sync configuration, job history, and entity metadata are cascade-deleted from the database.
  3. A background cleanup workflow is scheduled to remove data from the vector database (Vespa) and raw data storage (ARF). This may take several minutes for large datasets but does not block the response.

The API returns immediately after step 2. Vector database cleanup happens asynchronously -- the data becomes unsearchable as soon as the database records are deleted.

Warning: This action cannot be undone.

delete/source-connections/{source_connection_id}

Path parameters

source_connection_idstring uuid required

Unique identifier of the source connection to delete (UUID)

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

Unique identifier of the source connection to delete (UUID)

Response

Deleted source connection

idstring uuid required

Unique identifier of the source connection

organization_idstring uuid required

Organization this connection belongs to

namestring required

Display name of the connection

descriptionstring nullable

Optional description of the connection's purpose

short_namestring required

Source type identifier

readable_collection_idstring required

Collection this connection belongs to

status'active' | 'pending_auth' | 'syncing' | 'error' | 'inactive' | 'pending_sync' required

Source connection status enum - represents overall connection state.

created_atstring date-time required

When the connection was created (ISO 8601)

modified_atstring date-time required

When the connection was last modified (ISO 8601)

configobject nullable

Source-specific configuration values

sync_idstring uuid nullable

ID of the associated sync (internal use)

federated_searchboolean

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

Example response

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