Authentication

You will be provided with a unique API key when you first sign up for the service. REST API authentication is done simply via an HTTP header.

All API requests must be prepended with our base URL and namespace:

https://premium.aiera.com/api/

To test this, you can use this sample status endpoint:

Bash

curl --request GET \
  --url 'https://premium.aiera.com/api/status' \
  --header 'X-API-Key: xxx'

Python

import requests
requests.request(
    "GET", 
    "https://premium.aiera.com/api/status", 
    headers={"X-API-Key": "xxx"}
)

Example Output

{
	"status": "success",
	"hostname": "abcdefghijk",
	"timestamp": 1675707470.0724103,
	"results": [
		{
			"checker": "redis_available",
			"output": "redis ok",
			"passed": true,
			"timestamp": 1675707449.8726265,
			"expires": 1675707476.8726265
		},
		{
			"checker": "database_available",
			"output": "database ok",
			"passed": true,
			"timestamp": 1675707449.88277,
			"expires": 1675707476.88277
		}
	]
}