View all methods
connections.list
List all configured Data Cloud connections.
Facts
| Method | GET https://yourinstance.getdx.net/api/connections.list |
Arguments
Required arguments
| Name | Type | Description |
|---|---|---|
token |
Token |
Auth token passed as an HTTP header. |
Usage info
Returns all active (non-deleted, non-draft) connections ordered by type. Each connection record in the connections array contains 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"). |
disabled_at |
Timestamp |
When the connection was disabled, or null if active. |
last_synced_at |
Timestamp |
When the connection last completed a sync, or null. |
created_at |
Timestamp |
When the connection was created. |
supports_multiple_credentials |
Boolean |
Whether this connector type allows more than one credential. |
Example request
curl "https://yourinstance.getdx.net/api/connections.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. |