Certificates API

This guide is for the Certificates API, used to control your ADC's SSL certificates. Please see the API overview for information on using the Nova API.

Examples

List Certificates

This will return a list of your certificates, but not the certificate itself.

Variables

Method: GET
Endpoint: /api/certificates

Response

{
    "success": true,
    "data": {
        "certificates": [
            {
                "id": 1,
                "organisation_id": 1,
                "created_at": "2020-08-25T09:02:17.000000Z",
                "name": "test",
                "domains": "*.snapt.net, snapt.net",
                "adcs": false,
                "type": "pem",
                "expiry": "2021-10-06"
            },
            {
                "id": 2,
                "organisation_id": 1,
                "created_at": "2020-08-28T14:36:22.000000Z",
                "name": "test2",
                "domains": "*.nova-adc.com, nova-adc.com",
                "adcs": false,
                "type": "pem",
                "expiry": "2021-02-13"
            }
        ]
    }
}

Create a Certificate

Create a brand new certificate by sending a POST request with the name and PEM contents. Read more about PEM files here.

Variables

Method: POST

Variables: 
 - name: string
 - certificate: pem file

Endpoint: /api/certificates

Response

{
    "success": true,
    "data": {
        "id": 2,
        "message": "Certificate test2 was updated successfully. You may use the returned id to specify it in ADCs."
    }
}

Update a Certificate

Update an existing certificate, referenced by the {certificate_id} in the URL. Submit the same content as when creating a
certificate. Note: all existing ADCs using the certificate will redeploy it immediately.

Variables

Method: POST

Variables:
 - name: string
 - certificate: pem file

Endpoint: /api/certificates/{certificate_id}/update

Response

{
    "success": true,
    "data": {
        "id": 2,
        "message": "Certificate test2 was updated successfully. You may use the returned id to specify it in ADCs."
    }
}