Access tokens

Open in

Access tokens authenticate requests to the Control API and the Ably CLI. They are scoped to a specific account and grant a configurable set of capabilities. Manage your tokens from the Access tokens page in the Ably dashboard.

Create an access token

You must be an account admin to create access tokens. If you don't see the "Create new token" button, contact your account administrator.

To create a new access token:

  1. Go to the Access tokens page in the Ably dashboard.
  2. Click Create new token.
  3. Enter a Name for the token. This is for your reference only and is not used in API requests.
  4. Select the Account the token is scoped to. This is auto-selected if you only have one account.
  5. Select the Capabilities the token requires. Capabilities are grouped into categories such as Apps, Keys, Rules, Queues, Namespaces, and Statistics. Each category has individual read and write checkboxes, and a "Select all" toggle.
  6. Click Create token.

Access token capabilities

Capabilities control which operations the token can perform in the Control API and CLI. The dashboard displays human-readable labels such as "Read App". The raw format such as read:app appears in API responses and JWTs.

Dashboard labelAPI capabilityControl APICLI commands
Read Appread:appList appsably apps list
Write Appwrite:appCreate, update, and delete appsably apps create, ably apps update, ably apps delete
Read Keyread:keyList API keys for an appably auth keys list, ably auth keys get
Write Keywrite:keyCreate, update, and revoke API keysably auth keys create, ably auth keys update, ably auth keys revoke
Read Integrationread:ruleList and get integration rulesably integrations list, ably integrations get
Write Integrationwrite:ruleCreate, update, and delete integration rulesably integrations create, ably integrations update, ably integrations delete
Read Queueread:queueList queues for an appably queues list
Write Queuewrite:queueCreate and delete queuesably queues create, ably queues delete
Read Ruleread:namespaceList rules for an appably apps channel-rules list
Write Rulewrite:namespaceCreate, update, and delete rulesably apps channel-rules create, ably apps channel-rules update, ably apps channel-rules delete
Read Statsread:statsAccount and app statisticsably stats account, ably stats app

Revoke an access token

Revoke an access token from the Access tokens page by clicking the delete icon next to the token. Revocation is immediate and irreversible. Any requests using that token will fail.

Rate limits

The Control API limits the number of requests per account and per access token per hour. See API limits for details.