Developers

Appearance

Authentication ​

Abyssale uses API Key Authentication: your API key is passed along with every API call, allowing Abyssale to identify your company account and access your data.

How to get an API Key? ​

WARNING

Access to the API key requires at least an Admin role.

  1. Go to app.abyssale.com and log in
  2. Click Workspace settings in the left menu

Workspace settings

  1. Click API Key in the left menu
  2. Click the green Create new API key button

Create API key

Your API key will be available with a small delay of ~30 seconds. Copy it by clicking the copy icon on the right.

All requests must include an x-api-key header with your API Key.

How to test your authentication? ​

Call the GET /ready route with the header below:

bash
curl -i -H "x-api-key: {YOUR-API-KEY}" https://api.abyssale.com/ready
# HTTP/2 200

A 200 status code confirms authentication is working. The endpoint returns no response body.