API keys
Create crk_ keys in Dash. Revocation applies on the next request.
An API key belongs to your organization, not to a person. Only an admin can create a key. Dash manages the keys.
Format
A key does not work on the host of another organization. A key with a bad format or tag gets 401 invalid_api_key.
Create a key
- Open API keys in Dash.
- Select Create key.
- Enter a name and select the environment and the scopes.
- Copy the value.
Optional settings:
Live keys and test keys
A test key does not give a sandbox. Paperwork has no test credit pool. When the balance of the organization reaches zero, live keys and test keys both get 402 credits_exhausted.
Revoke a key
Select a key in Dash and revoke it. Revocation applies on the next request. An open job stream of the key ends with no terminal event and no job output.
To rotate a key, create the new key, deploy it, then revoke the old key. Dash shows the last-used time of each key.