Authentication API

All Atatus API requests require authentication. You will have to send your requests through a secure HTTPS communication. All other requests will simply be ignored. An API key is a must in order to send us an authentic API request.

Generate New API Key

1. Login to the Atatus dashboard as the account Owner or Admin.
2. Go to Settings » Account Settings and click on API Keys tab.
3. Click on the New API Key button.
4. Provide the API Key Name and Select Permission as either "Read", "Write" or "Read & Write"
5. Click on the Create button.

You will get a new API Key that you can use to make API requests.

Usage

There are 3 ways to send us the request:

1. You can send the API key in the authorization header.

   copy

   curl -H "X-API-KEY: YOUR_API_KEY_HERE" https://api.atatus.com/v2
   

2. You can authenticate using a query parameter. This is convenient for GET/DELETE requests.

   copy

   curl https://api.atatus.com/v2?api_key=YOUR_API_KEY_HERE
   

3. You can send the API key in the request body. This is convenient for POST/PUT requests.

   copy

   curl https://api.atatus.com/v2 -F api_key="YOUR_API_KEY_HERE"
   

Status Codes

Each response will have a status code that tells you the result of your request. Below mentioned table specifies some of the codes and its associated meaning.

Error Message

Atatus uses relevant HTTP response codes to inform the results of the API requests. Generally, codes from the 200 series indicate a good request. Codes from the 400 series indicate errors due to misinformation from your side. Codes from the 500 series indicate Atatus server errors. A sample error response message:

{
    "Message" : "API key is invalid!"
}