This documentation is deprecated. Please refer our new documentation here


All requests to the Atatus API require authentication. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. To authenticate API requests, you need to know your Admin API Key that you can find in your project settings.

There are three ways to send the Admin API key with requests.

1. You can authenticate using a query parameter. This will be convenient for GET/DELETE requests.


2. You can send Admin API Key in request body. This will be convenient for POST/PUT requests.

curl \
  -F admin_api_key="YOUR_ADMIN_API_KEY_HERE"

3. You can also send the Admin API key in an Authorization header:

curl -H "Authorization: token YOUR_ADMIN_API_KEY_HERE" \
HTTP Status Codes

Every response will have a HTTP status code that will rather accurately describe the result of the operation.

Status Code Meaning
200 OK - Everything worked as expected.
201 Created - Resource is created.
204 No Content - There is no information to send back. It is returned for delete action.
400 Bad Request - Your request sucks
401 Unauthorized - Your API key is wrong
403 Forbidden - The item requested is hidden for administrators only
404 Not Found - The specified item could not be found
405 Method Not Allowed - You tried to access a item with an invalid method
429 Too Many Requests - You're requesting too many items! Slow down!
500 Internal Server Error - We had a problem with our server. Try again later.
503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.
HTTP Errors

Atatus uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate an error with Atatus's servers. The error response has message for failure as follows

  "message": "Admin API Key is invalid!"
Document Sections