API Key

API Keys are great for API access. To create an API Key, you can use the dashboard, or generate one when creating a Stack (if you have access to do so).

Once an API key is obtained, be sure to store it somewhere safe, because the system will not be able to retrieve your API key for you.

Note

Our API Keys are stored like passwords, with a one-way cryptographic hashing function. This means we'll be able to verify your API key when you provide it, but we'll never be able to tell you what it is.

Using an API Key

Endpoints that accept an API key will do so via the APIKey header.

Warning

Legacy endpoints will require the API Key by query parameter. These endpoints will be marked as legacy in documentation.