Token status

Learn about the different states of an API token.

An API token allows you to authenticate requests to the REST API.

A token can currently exist in these states: Active, Disabled, or Deleted. The following diagram shows the transitions between these states:

The state transition diagram of an API token.

The following table provides a description of the different statuses:

State
Definition

Active

The token has been authenticated in the account. It will allow access to the endpoint.

Disabled

The token has been temporarily deactivated. Any attempts to access the endpoint will return an error.

Deleted

The token has been permanently removed from the system. This state is not visible to the client or vendor account users.

Last updated

Was this helpful?