Get

1 from airweave import AirweaveSDK 2 3 client = AirweaveSDK( 4 framework_name="YOUR_FRAMEWORK_NAME", 5 framework_version="YOUR_FRAMEWORK_VERSION", 6 api_key="YOUR_API_KEY", 7 ) 8 client.source_connections.get( 9 source_connection_id="source_connection_id", 10 )

1 { 2 "id": "string", 3 "name": "string", 4 "description": "string", 5 "short_name": "string", 6 "readable_collection_id": "string", 7 "status": "active", 8 "created_at": "2024-01-15T09:30:00Z", 9 "modified_at": "2024-01-15T09:30:00Z", 10 "auth": { 11 "method": "direct", 12 "authenticated": true, 13 "authenticated_at": "2024-01-15T09:30:00Z", 14 "expires_at": "2024-01-15T09:30:00Z", 15 "auth_url": "string", 16 "auth_url_expires": "2024-01-15T09:30:00Z", 17 "redirect_url": "string", 18 "provider_readable_id": "string", 19 "provider_id": "string" 20 }, 21 "config": {}, 22 "schedule": { 23 "cron": "string", 24 "next_run": "2024-01-15T09:30:00Z", 25 "continuous": false, 26 "cursor_field": "string" 27 }, 28 "sync": { 29 "total_runs": 0, 30 "successful_runs": 0, 31 "failed_runs": 0, 32 "last_job": { 33 "id": "string", 34 "status": "created", 35 "started_at": "2024-01-15T09:30:00Z", 36 "completed_at": "2024-01-15T09:30:00Z", 37 "duration_seconds": 1.1, 38 "entities_inserted": 0, 39 "entities_updated": 0, 40 "entities_deleted": 0, 41 "entities_failed": 0, 42 "error": "string" 43 } 44 }, 45 "sync_id": "string", 46 "entities": { 47 "total_entities": 0, 48 "by_type": {} 49 }, 50 "federated_search": false 51 }

Get a source connection with optional depth expansion.

Authentication

x-api-keystring

API Key authentication via header

Path Parameters

source_connection_idstringRequiredformat: "uuid"

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.

federated_searchboolean or nullDefaults to false

Whether this source uses federated search

Authentication

Path Parameters

Headers

Response

Errors