Sign in

v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB
Connectors

Get a Connector by id

:warning: This is a new API which is still subject to change.

Use this endpoint to get a Connector's details by id.

get/v1/data-acquisition/connectors/{id}

Path parameters

idstring required

The Connector's id.

Query parameters

resolveSecretsboolean

If true, resolves secrets in the Connector's config. Requires organization admin permissions.

includestring[]

Include additional Connector fields. 'config' includes the Connector's config. 'artifact' includes the Connector artifact's details.

Response

Successful response with a Connector's details

idstring required

The Connector's id.

namestring required

The Connector's name.

orgSlugstring required

The organization slug that the Connector belongs to.

descriptionstring

The Connector's description.

hostType'cloud' | 'hub' required

The type of host the Connector is running on.

metadataobject required

The Connector's metadata. Deprecated in favor of labels.

tagsstring[] required

The Connector's tags. Deprecated in favor of labels.

commandQueuestring required

The ARN of the Connector's command queue.

clusterArnstring required

The ARN of the ECS cluster the Connector is running in.

taskDefinitionArnstring required

The ARN of the ECS task definition the Connector is running.

health'HEALTHY' | 'WARNING' | 'CRITICAL' | 'N/A' required

The health status of the Connector. N/A indicates the Connector has never reported health.

healthErrorCodestring

The error code of the Connector's health status, if unhealthy. Defined by each Connector and used to display an error message in the UI.

operatingStatusstring required

The desired operating status of the Connector. RUNNING means the Connector should run all tasks; IDLE means the Connector software should run and awaiting commands, but not performing its main (Connector-defined) tasks yet; DISABLED means the software should not run at all.

networkStatus'Online' | 'Offline' required

The network status of the Connector.

configobject

The Connector's current configuration, schema varies per Connector.

lastSeenAtstring date-time required

The last time the Connector was seen by the platform.

updatedAtstring date-time required

The last time the Connector's details were updated.

createdAtstring date-time required

The time the Connector was created.