Connector
/api/v1/integration/connectorsA data source/sink connector instance.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| type | string | Integration type category. |
| provider | string | Vendor, e.g. defender_for_endpoint, splunk, jira, okta. |
| name | string | Human-readable connector name. |
| scope | string | org = tenant-wide; user = personal; group = group-scoped. |
| owner_id | string | usr-<uuid> of the owning user. |
| group_id | string | Group ID if scope=group. |
| user_id | string | User ID if scope=user. |
| config | json | Non-secret configuration: baseUrl, region, accountId, etc. |
| vault_path | string | KV v2 Vault path to secrets, e.g. secret/data/tnt-.../connectors/cnn-.../credentials. |
| auth_type | string | Authentication mechanism. |
| oauth_refresh_needed | boolean | Whether the OAuth token needs refreshing. |
| oauth_token_expires_at | date-time | When the OAuth access token expires. |
| enabled | boolean | Whether the connector is active. |
| sync_status | string | Current sync health. |
| last_sync_at | date-time | Timestamp of the last successful sync. |
| consecutive_errors | number | Count of consecutive sync errors. |
| last_error | string | Last error message. |
| metrics | json | { totalSynced, last24h, avgLatencyMs } |
| event_types | json | Event types this connector emits. |
| webhook_endpoint_id | string | ID of the outbound Webhook endpoint, if applicable. |
| credential_last_rotated_at | date-time | When credentials were last rotated. |
| next_rotation_due | date-time | When credentials are next due for rotation. |
| tags | json | Free-form tags. |
| version | number | Optimistic concurrency version counter. |
| application_id | uuid | Owning application id (FK to Application). |
API
Loading manifest…