--- title: "Get a Connector by id" method: GET path: "/v1/data-acquisition/connectors/{id}" tags: ["Connectors"] --- # Get a Connector by id `GET /v1/data-acquisition/connectors/{id}` ## Request - Base URL: `https://api.tetrascience.com` - URL: `https://api.tetrascience.com/v1/data-acquisition/connectors/{id}` - Auth: API key in header `ts-auth-token` and API key in header `x-org-slug` **:warning: This is a new API which is still subject to change.** Use this endpoint to get a Connector's details by id. ## Path parameters - `id` string, required ## Query parameters - `resolveSecrets` boolean - `include` string[] ## Response `200` Successful response with a Connector's details - ConnectorDetailsDto: Details of a single Connector. - `id` string, required: The Connector's id. - `name` string, required: The Connector's name. - `orgSlug` string, required: The organization slug that the Connector belongs to. - `description` string: The Connector's description. - `artifact` union, required: The Connector's artifact details. If include=artifacts is specified on the request, it will be the ArtifactDetailsDto; otherwise it will be the ArtifactDto. - ArtifactDto - `namespace` string, required - `slug` string, required - `version` string, required - ArtifactDetailsDto: This is the detailed version of the ArtifactDto. Includes dynamic fields from the artifact's manifest, so not all response keys are listed here. - `namespace` string, required - `slug` string, required - `version` string, required - `name` string, required - `description` string, required - `sourceType` string, required - `ui` ConnectorUiDto, required - `components` union[], required - union - ConnectorGeneratedConfigUiComponentDto - … - ConnectorCustomConfigUiComponentDto - … - ConnectorCustomRouteUiComponentDto - … - `hostType` 'cloud' | 'hub', required: The type of host the Connector is running on. - `hub` HubDto - `id` string, required: The Hub's id. - `name` string, required: The Hub's name. - `orgSlug` string, required: The organization slug that the Hub belongs to. - `description` string: The Hub's description. - `httpProxyHost` string: The Hub's http parent proxy host, if set. - `httpProxyPort` number: The Hub's http parent proxy port, if set. - `httpProxyUsername` string: A legacy field from when Hub's parent proxy was configured in the cloud; no longer populated. - `httpsProxyHost` string: The Hub's https parent proxy host, if set. - `httpsProxyPort` number: The Hub's https parent proxy port, if set. - `httpsProxyUsername` string: A legacy field from when Hub's parent proxy was configured in the cloud; no longer populated. - `noProxy` string: The Hub's no proxy list, if set. - `l7ProxyForwardPort` number, required: The Hub's L7 proxy forward port, used by Agents automatically when using this Hub. - `l7ProxyReverseHttpPort` number, required: The Hub's L7 proxy reverse http port, configured explicitly on Agents. - `l7ProxyReverseHttpsPort` number, required: The Hub's L7 proxy reverse https port, configured explicitly on Agents. - `l7ProxySocatPort` number, required: The Hub's L7 proxy socat port. Not used externally, but configurable to avoid port conflicts. - `l7ProxyReverseMqttPort` number: The Hub's L7 proxy reverse mqtt port, if set, configured explicitly on IoT Agents. - `l7ProxySocatMqttPort` number: The Hub's L7 proxy socat mqtt port. Not used externally, but configurable to avoid port conflicts. - `l7ProxyLocalnets` string, required: The Hub's L7 proxy localnets, if set. - `l7ProxyDnsNameservers` string: The Hub's L7 proxy dns nameservers, if set explicitly. Otherwise, defaults to the host VM's. - `l7ProxyWhitelist` string: The Hub's L7 proxy whitelist, if set. If not set, all endpoints are allowed. - `l7ProxyMaximumMemoryMb` number, required: The Hub's L7 proxy maximum memory in MB, if set. - `enabled` boolean, required: Whether the Hub is enabled. When disabled, Hub Connectors are disabled but the SSM and ECS Agents continue to await commands. - `status` HubStatusDto - `health` object, required: The health status of the Hub. - `breakdown` object[] - `name` 'Availability' | 'CPU' | 'Disk' | 'Memory' | 'ProxyMemory' | 'ProxyMemoryMax' | 'ProxyAvailability' - `status` 'HEALTHY' | 'WARNING' | 'CRITICAL' - `status` 'HEALTHY' | 'WARNING' | 'CRITICAL': The overall health status of the Hub. Rolls up to the most severe status in the breakdown. - `network` 'Online' | 'Offline' | 'Never Seen', required: The network status of the Hub. - `lastSeen` string, date-time, required: The last time the Hub was seen by the platform. - `metrics` object[], required - `cpuUsedSystem` object - `value` number - `unit` 'Percent' - `cpuUsedUser` object - `value` number - `unit` 'Percent' - `diskFree` object - `value` number - `unit` 'Bytes' - `diskUsed` object - `value` number - `unit` 'Percent' - `memoryUsed` object - `value` number - `unit` 'Bytes' - `memoryFree` object - `value` number - `unit` 'Bytes' - `memoryBuffered` object - `value` number - `unit` 'Bytes' - `memoryCached` object - `value` number - `unit` 'Bytes' - `memoryAvailable` object - `value` number - `unit` 'Bytes' - `memoryTotal` object - `value` number - `unit` 'Bytes' - `memoryUsedPercentOfReservation` object - `value` number - `unit` 'Percent' - `memoryMax` object - `value` number - `unit` 'Bytes' - `proxies` object, required: The status of the Hub's built-in Agent proxies. - `l7` object - `startedAt` string, date-time - `status` 'RUNNING' | 'STOPPED' - `l7ReverseNginx` object - `startedAt` string, date-time - `status` 'RUNNING' | 'STOPPED' - `l7ReverseSocat` object - `startedAt` string, date-time - `status` 'RUNNING' | 'STOPPED' - `metrics` object[] - `cpuUsed` object - `value` number - `unit` 'Percent' - `memoryUsed` object - `value` number - `unit` 'Bytes' - `memoryUsedPercentOfMax` object - `value` number - `unit` 'Percent' - `memoryUsedPercentOfReservation` object - `value` number - `unit` 'Percent' - `memoryMax` object - `value` number - `unit` 'Bytes' - `host` HubHostDto, required - `ipAddress` string, required: The Hub's IP address. - `hostName` string, required: The Hub's host name. - `platformName` string, required: The Hub's operating system name. - `platformVersion` string, required: The Hub's operating system version. - `updatedAt` string, date-time, required - `createdAt` string, date-time, required - `activationExpiresAt` string, date-time, required: The time at which the Hub's activation will expire. 24 hours after creation. - `ssmInstanceId` string: The Hub's AWS Systems Manager instance id, if the Hub has been installed. - `ecsContainerInstanceArn` string: The Hub's AWS ECS container instance ARN, if the Hub has been installed. - `metadata` object, required: The Connector's metadata. Deprecated in favor of labels. - `tags` string[], required: The Connector's tags. Deprecated in favor of labels. - `labels` LabelDto[], required: The Connector's labels. - `id` string, required - `name` string, required - `value` string, required - `commandQueue` string, required: The ARN of the Connector's command queue. - `clusterArn` string, required: The ARN of the ECS cluster the Connector is running in. - `taskDefinitionArn` string, 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. - `healthErrorCode` string: 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. - `operatingStatus` string, 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. - `config` object: The Connector's current configuration, schema varies per Connector. - `lastSeenAt` string, date-time, required: The last time the Connector was seen by the platform. - `updatedAt` string, date-time, required: The last time the Connector's details were updated. - `createdAt` string, date-time, required: The time the Connector was created. --- [API](https://skmtc.dev/tetrascience/apis/hubs-connectors.md) - [All operations](https://skmtc.dev/tetrascience/apis/hubs-connectors/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrascience/apis/hubs-connectors/revisions/efd351718bc7?raw)