API Credentials
NOTE A user needs to be an account admin to access the API settings page.
From the account page, switch to the Settings tab, then select API Keys from the settings sidebar.
The API Keys page will show a list of existing keys along with their Scope, Mode, and Status. Press the Add New API Key button to generate a new key.
- Scope - determines which projects an API key can access; Account keys can access all projects, and Project keys can only access the specified projects.
- Mode - determines which endpoints an API key can request to; Read-Write keys can access all endpoints, and Read keys can only access read endpoints.
- Status - determines if an API key is valid; only Active keys can be used to make requests to the API.
WARNING The API key is NOT the same as the identifier. The API key will only be shown once, immediately after its creation. It is strongly recommended to write it down. If the API key is lost, a new key will need to be generated.
For more information, refer to the API documentation at https://api.cxalloy.com.