Search documentation
Search pages, API reference sections, and guide headings.
Summary
Connectors are the public storage integration boundary for import and export workflows. The API supports provider-specific creation, listing, retrieval, testing, browsing, update, and deletion.
Connector endpoints
| Method | Path | Purpose |
|---|---|---|
POST | /api/v2/connectors/gcs | Create a GCS connector |
POST | /api/v2/connectors/s3 | Create an S3 connector |
POST | /api/v2/connectors/azure | Create an Azure Blob connector |
GET | /api/v2/connectors | List connectors |
GET | /api/v2/connectors/{connector_id} | Retrieve one connector |
PATCH | /api/v2/connectors/{connector_id} | Update mutable connector fields |
POST | /api/v2/connectors/{connector_id}/test | Validate access |
POST | /api/v2/connectors/{connector_id}/browse | Browse files with prefix and pattern |
DELETE | /api/v2/connectors/{connector_id} | Delete a connector |
Common connector fields
| Field | Notes |
|---|---|
name | Human-readable connector name |
scopes | One or both of import and export |
export_base_path | Optional export boundary inside the storage namespace |
import_mode | all or new_only |
Provider-specific creation
GCScreation uses multipart form data withcredentials_file.S3creation uses JSON withbucket,region,aws_access_key_id, andaws_secret_access_key.Azurecreation uses JSON withstorage_account,container,tenant_id,client_id, andclient_secret.
Example: create an S3 connector
curl -X POST /api/v2/connectors/s3 \
-H "X-API-Key: sk_live_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: connector-s3-archive" \
-d '{
"name": "Archive S3",
"bucket": "media-archive",
"region": "us-east-1",
"aws_access_key_id": "AKIA...",
"aws_secret_access_key": "<secret>",
"scopes": ["import", "export"],
"export_base_path": "exports/review",
"import_mode": "new_only"
}'
Example: browse files
curl -X POST /api/v2/connectors/conn_123/browse \
-H "X-API-Key: sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"prefix": "incoming/2026/04/",
"pattern": "*.mp4"
}'
SDK equivalents
client.connectors.create_gcsclient.connectors.create_s3client.connectors.create_azureclient.connectors.testclient.connectors.browse
Keep export destinations inside the connector's configured export_base_path. Public export requests are
validated against that boundary.
Related documentation
Connectors provide the storage access boundary for imports and exports. This guide shows how to create them, test them, and choose scopes safely.
Import jobs bring cloud storage media into a target index. Use automations when the same connector path should feed recurring media intake.
Exports package run-backed metadata for download or connector delivery. The public API supports export creation by index or run plus status retrieval and listing.
