Connectors
Activate connectors on a deployment and manage running connector instances via the API.
Set variables to auto-fill all examples and run requests in-browser.
Connectors are natively compiled Rust plugins that run inside deployments. Activation goes through the main API. Instance management uses the Supervisor API.
Required permissions: deployment:connector:manage to activate/delete, deployment:connector:read to list.
Activation (Main API)
List Available Connectors
GET/tenants/{tenant_id}/divisions/{division_id}/environments/{environment_id}/deployments/{deployment_id}/connectorsBrowse the connector catalog with availability and activation status for your deployment.
curl "https://api.laserdata.cloud/tenants/{tenant_id}/divisions/{division_id}/environments/{environment_id}/deployments/{deployment_id}/connectors?type=sink&page=1&results=10" \
-H "ld-api-key: YOUR_API_KEY"| Query Parameter | Description |
|---|---|
type | Filter by source or sink |
Activate a Connector
POST/tenants/{tenant_id}/divisions/{division_id}/environments/{environment_id}/deployments/{deployment_id}/connectors/activateActivate a connector on this deployment. The connector starts in Pending status and transitions to Active once nodes process the task.
curl -X POST https://api.laserdata.cloud/tenants/{tenant_id}/divisions/{division_id}/environments/{environment_id}/deployments/{deployment_id}/connectors/activate \
-H "ld-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"connector_key": "postgres",
"connector_type": "sink",
"instance_name": "Orders to Postgres",
"instance_key": "orders-pg-sink"
}'| Field | Required | Description |
|---|---|---|
connector_key | Yes | Connector identifier (e.g. postgres, elasticsearch, iceberg) |
connector_type | Yes | source or sink |
instance_name | No | Human-readable name for this instance |
instance_key | No | Unique key within the deployment (auto-generated if omitted, e.g. postgres-sink) |
Returns 202 Accepted. You can activate multiple instances of the same connector for different configurations.
Instances (Supervisor API)
A connector instance is a running copy of a connector on a deployment node.
List Connector Instances
GET{supervisor_url}/deployments/{deployment_id}/connectors/instancesList all connector instances on the deployment.
curl {supervisor_url}/deployments/{deployment_id}/connectors/instances \
-H "ld-api-key: YOUR_API_KEY"[
{
"id": 1,
"deployment_id": 611298765432109056,
"connector_type": "sink",
"connector_key": "postgres",
"name": "Orders to Postgres",
"key": "orders-pg-sink",
"status": "active"
}
]Instance statuses: pending, active, inactive, failed
Delete a Connector Instance
DELETE{supervisor_url}/deployments/{deployment_id}/connectors/instances/{instance_id}Stop and remove a connector instance from all nodes.
curl -X DELETE {supervisor_url}/deployments/{deployment_id}/connectors/instances/{instance_id} \
-H "ld-api-key: YOUR_API_KEY"Returns 204 No Content.