Backends 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.

This guide is for the Backends API, used to control your ADC Backends.


List Backends

Method: GET
Endpoint: /api/backends 

This will return a list of your backends. It is important to note the "provider", which is the "type" of ADC you must use when editing them.

{
    "success": true,
    "data": {
        "backends": [
            {
                "id": 3,
                "organisation_id": 1,
                "created_by": 2,
                "created_at": "2019-10-17 05:37:52",
                "name": "apiBackend",
                "provider": "simple"
            },
            {
                "id": 1,
                "organisation_id": 1,
                "created_by": 2,
                "created_at": "2019-10-10 09:29:07",
                "name": "Partner",
                "provider": "dns"
            }
        ]
    }
}

Create a Backend

Variables

Method: POST

Variables: 
 - name: string
 - type: simple|dns|cloud_api|servicedisc

Endpoint: /api/backends

Response

{
    "success": true,
    "data": {
        "id": 4,
        "message": "Backend apiBackend added successfully. You may use the returned id to configure it."
    }
}

Delete a Backend

Variables

Method: POST

Endpoint: /api/backends/{id}/delete

Response

{
    "success": true,
    "data": {
        "id": "4",
        "message": "Backend deleted successfully."
    }
}

Edit a Simple Backend

Variables

Method: POST

Variables:
 - id: integer [id of the backend to modify] 
 - ips[i]: ip address 
 - ips_weights[i]: integer
 - ips_state[i]: primary|backup

Endpoint: /api/backends/{id}/simple/update 

Response

{
    "success": true,
    "data": {
        "id": "3",
        "message": "Backend apiBackend updated successfully."
    }
}