credentials.delete

Soft-delete a credential so it no longer appears in normal lists.

Facts

POST https://yourinstance.getdx.net/api/connections/:connection_id/credentials.delete

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`

JSON body (top-level keys)

Name	Type	Description
`id`	`Integer`	Required. ID of the credential to delete. Example: `456`

Usage info

Send Content-Type: application/json with a JSON object containing id, or submit equivalent form parameters, depending on your client.

Example request

curl -X POST "https://yourinstance.getdx.net/api/connections/123/credentials.delete" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer xxxx-xxxxxxxxx-xxxx" \
  --data '{ "id": 456 }'

Success response

On success the API returns:

{ "ok": true }

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.
`invalid_json`	The JSON body could not be parsed.