credentials.info

Return details for a single credential on a connection.

Facts

GET https://yourinstance.getdx.net/api/connections/:connection_id/credentials.info/:id

Arguments

Required arguments

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

Usage info

The response contains a credential object with the following fields. secrets are not returned.

Field	Type	Description
`id`	`Integer`	The credential ID.
`type`	`String`	The connector type (e.g. `"jira_cloud"`).
`label`	`String`	Display name of the credential.
`settings`	`JSON`	Non-secret configuration stored for the credential. Shape varies by connector type.
`created_at`	`Timestamp`	When the credential was created.
`disabled_at`	`Timestamp`	When the credential was disabled, or `null` if active.
`deleted_at`	`Timestamp`	When the credential was soft-deleted, or `null`.
`expiration_date`	`Date`	The credential’s expiration date, or `null` if not set.

settings keys and meanings vary by connector type. For connector-specific payload documentation, contact DX support.

Example request

curl "https://yourinstance.getdx.net/api/connections/123/credentials.info/456" \
  -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 `connection_id`.
`credential_not_found`	No credential exists for the given `id` on that connection.