These docs are for v2. Click to read the latest docs for v3.

Update your credential

Updates the details of a specific credential for your API client. You can change the expiration date, description, or toggle the activation status. This isn't the same as rotating a credential. For details, see Rotate credentials.

Path Params
integer
required

A credential's unique identifier.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params
string
required

Identifies the API client.

integer
required

A unique identifier for each credential.

string
required

Notes or description for credentials.

string
required

Identifies the condition of the credential.

Response

Response body
object
string
required

Identifies the API client.

date-time
required

ISO 8601 timestamp indicating when credentials were created.

integer
required

A unique identifier for each credential.

string
required

Notes or description for credentials.

date-time
required

ISO 8601 timestamp indicating when the credential expire. By default, two years from the creation date.

string
required

Indicates credentials' status.

Language
Authentication
URL