credentials.list

List credentials configured for a Data Cloud connection.

Facts


Method	`GET https://yourinstance.getdx.net/api/connections/:connection_id/credentials.list`

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`

Usage info

Each credential in the credentials array contains the following fields. secrets are never returned in list payloads.

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.
`expiration_date`	`Date`	The credential’s expiration date, or `null` if not set.

The shape of settings depends on the connector type. If you need field-level specs for a connector, contact DX support.

Example request

curl "https://yourinstance.getdx.net/api/connections/123/credentials.list" \
  -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`.