Create an API key
Open the Developers section
Create a key
Select Create API Key, give it a descriptive name (for example,
Production server), and confirm. You can have up to 5 keys at a time.Key format
A key has the following shape:keyId— an 8-character non-secret prefix used to identify the key in the dashboard.secret— a 32-character high-entropy secret.
Authenticate a request
Pass the key in theAuthorization header as a Bearer token.
IP restriction
You can restrict each account’s API keys to a single IPv4 address from the Developers section. When enabled, any request from a different address is rejected with403. Enter the public IPv4 address of your server, and leave it blank to disable the restriction.
Revoke a key
Revoke a key from the dashboard at any time. Any server still using a revoked key loses access immediately, so roll keys by creating the replacement first and updating your environment before revoking the old one.Errors
A missing, malformed, or revoked key returns401. A key used from a disallowed IP returns 403. See Rate limits and errors for the full error model.