API

Nova ADC provides an easy-to-use REST based API, with token based authentication. The entire product is exposed via API, allowing you to incorporate it into your DevOps tooling, or automate your scaling operations.


Tokens

Nova uses standard token based authentication (JWT) for API requests. Under your user API menu you can generate and revoke tokens for your account, as well as set the scopes for the token.

This allows you to create read-only tokens, or tokens with limited access to your account.

{warning} Protect your tokens like you would the password to your account!


Using the API

The API is available via the https://nova-adc.com/api/ URL. Within this namespace we expose the various endpoints for system functionality, available in more detail under the API endpoints documentation.

curl -i https://nova-adc.com/api/nodes -H "Authorization: Bearer YOUR_TOKEN_HERE"

This will return a list of your nodes, as well as some statistics about them:

{
    "success": true,
    "data": {
        "nodes": [
            {
                "id": 29,
                "organisation_id": 3,
                "created_by": 2,
                "created_at": "05:53:38+00",
                "active": true,
                "name": "exampleNodeName",
                "key": "..",
                "uuid": ".."
            }
        ],
        "stats": {
            "connectedNodesCount": 1,
            "activeNodesCount": 1,
            "totalCpu": "0.00",
            "totalMemory": "0.00"
        }
    }
}

Rate Limits

The API allows 60 requests every minute. Importantly, this is not one a second, but rather a count of 60 within a minute meaning you can burst up to 60 in single second. We provide standard API rate limit heads for your application to monitor

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
Retry-After: 59

Should you require more than 60 requests per minute please contact us.