CA Certificate

Endpoints for getting and setting certificate information

• Get CA certificates info : GET /api2/system/ca_certificates admin
• Import a new CA certificate : POST /api2/system/ca_certificates admin
  • usage: the certificate file has to be sent as form-data with key: ca_cert
  • the file must be a PEM-encoded CA certificate (its basicConstraints say CA:TRUE), with a .crt or .pem extension in any case (Root.CRT and root.pem are both accepted). It is stored under its file name with the extension replaced by .crt (Root.CRT is stored as Root.crt, root.pem as root.crt), which is the name the other two endpoints list and delete it by; importing a file whose stored name already exists replaces it.
  • a 400 is returned when the extension is not one of those, when the file is not a PEM-encoded CA certificate (an end-entity certificate, a private key, a DER file or a truncated one are all refused), when no file is attached, and when the maximum number of CA certificates is already stored.
  • JSON structure
• Delete one or all CA certificates : POST /api2/system/ca_certificates/delete admin
  • usage: provide a certificate name to delete a specific certificate, or send an empty name to delete all certificates
  • JSON structure

Json structures

Import CA cert json structure

[
    {
        "timestamp": 4872857948,
        "name": "certificate1.crt"
    },
    {
        "timestamp": 48728554398,
        "name": "certificate2.crt"
    }
]

Delete CA cert(s)

Delete a specific certificate by name:

{
    "name": "certificate1.crt"
}

Delete all certificates:

{
    "name": ""
}

Back to X2-SERIES API Home