Connectors
Browse plugins, activate connectors, and manage deployment instances
Set variables to auto-fill all examples and run requests in-browser.
Connectors run compiled Rust plugins in deployments. Use the Main API for activation and the Supervisor API for instances.
Activation and deletion require deployment:connector:manage. Listing requires deployment:connector:read.
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-{operation_id}) |
The endpoint returns 202 Accepted and creates disabled initial configuration. Enable it under the returned instance key. Instances of one plugin keep separate histories. See Connector Configuration.
Instances (Supervisor API)
An instance is a copy of a connector running 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 are pending, active, inactive, and 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"A successful request returns 204 No Content.