connections.info

Return detailed information for a single connection.

Facts


Method	`GET https://yourinstance.getdx.net/api/connections.info/:id`

Arguments

Required arguments

Name	Type	Description
`token`	`Token`	Auth token passed as an HTTP header.
`id`	`Integer`	The connection ID. Substitute this value for `:id` in the URL path. Example: `123`

Usage info

The response contains a connection object with the following fields:

Field	Type	Description
`id`	`Integer`	The connection ID.
`type`	`String`	The connector type (e.g. `"github"`, `"jira_cloud"`).
`name`	`String`	Display name of the connection.
`state`	`String`	Current state of the connection (e.g. `"verified"`).
`settings`	`JSON`	Non-secret configuration stored for the connection. Shape varies by connector type.
`disabled_at`	`Timestamp`	When the connection was disabled, or `null` if active.
`disabled_reason`	`String`	Human-readable reason for the connection being disabled, or `null`.
`last_synced_at`	`Timestamp`	When the connection last completed a sync, or `null`.
`created_at`	`Timestamp`	When the connection was created.
`updated_at`	`Timestamp`	When the connection was last updated.
`supports_multiple_credentials`	`Boolean`	Whether this connector type allows more than one credential.

If no connection exists for the given id, the response is { "ok": false, "error": "connection_not_found" }.

Example request

curl "https://yourinstance.getdx.net/api/connections.info/123" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx"

Errors

This table lists common errors for this method. Other errors can be returned if the service is unavailable or an unexpected failure occurs. Callers should always check the ok field in the response.

Error	Description
`not_authed`	The request did not include a valid API key.
`connection_not_found`	No connection exists for the given `id`.