An Access Token is a secure credential used to authenticate and authorize API requests to the platform. It allows automated systems to interact with the platform APIs without using account passwords.
Each token is associated with specific permissions and can be revoked at any time, helping maintain security and control over API access.
For more information about the available APIs, refer to the API documentation.
Creating an Access Token #
To create a new access token:
- Navigate to the Account page.
- In the sidebar, select Account Tokens.
- Click the Generate Token button.
- Complete the new token form:
- Token Name – Enter a name for the token.
- Role – Select the appropriate role for the token. If you need a token to purge content via API, select Purge.
- Expiration Date – After this date, the token can no longer be used. You can enable the No Expiration option to create a token without an expiration date.
5. Click the Create button.
The new token will be displayed after it is created.
Make sure to copy and securely store the token before closing the window, as it will not be accessible afterward.
Restricting a Token to Specific Services #
By default, a newly created token has access to all services.
If necessary, you can restrict the token so that it can only access a specific set of services.
To restrict a token:
- Navigate to the Account page.
- In the sidebar, select Account Tokens.
- Locate the token and select Service Restrictions from the Options dropdown.
- Select Specific Services and choose the services the token should be allowed to access.
- Click Approve.
Deleting an Access Token #
You can revoke an access token by deleting it from your account.
To delete a token:
- Navigate to the Account page.
- In the sidebar, select Account Tokens.
- Locate the token and select Delete Token from the Options dropdown.
- Click Delete.
Once deleted, API requests using that token will no longer be authorized.