CA Certificate

Install certificate authority certificates trusted by the device

CA certificates installed here are added to the device’s system trust store. They are used when the device itself acts as a TLS client, for example when it verifies an LDAP server in strict mode (see AAA LDAP Configuration). Up to three certificates can be installed. Every change is applied immediately.

API

• Data (CA_CERTIFICATE object):

  {
      "name": "corporate-root.crt",
      "timestamp_s": 1790585449
  }

  • name - file name of the certificate as uploaded; it is also the identifier used for deletion
  • timestamp_s - installation time, epoch seconds

• Get all installed CA certificates

  • Path: /api/ca_certificates
  • Method: GET
  • Minimum user role: admin
  • Response on success (200 OK): array of CA_CERTIFICATE objects in data, newest first

• Install a CA certificate

  • Path: /api/ca_certificates

  • Method: POST

  • Minimum user role: admin

  • Request body: multipart/form-data with one file part named ca_cert containing a PEM certificate. The file name must end with .crt; the device only adds .crt files to its trust store.

  • Response on success (200 OK): the installed CA_CERTIFICATE in data

  • Response on failure (400 Bad Request):

    • {"message": "No CA certificate file is sent", "data": null} when the ca_cert part is missing
    • {"message": "CA certificate is not a valid", "data": null} when the file is not a PEM certificate
    • {"message": "Maximum number of allowed CA certificates has been reached", "data": null} when three certificates are already installed

  • Notes: uploading a file with the name of an installed certificate replaces that certificate.

  • Example:

    curl -k -X POST -H "authorization: <token>" -F "ca_cert=@corporate-root.crt" https://<ip-address>/api/ca_certificates

• Delete one CA certificate

  • Path: /api/ca_certificates?certificate=<name>
  • Method: DELETE
  • Minimum user role: admin
  • URL parameters: certificate - the name of the certificate to delete
  • Response on success (200 OK): {"message": "Successfully deleted the CA certificate", "data": null}
  • Response on failure (400 Bad Request): {"message": "Couldn't delete the CA certificate(s) at the moment", "data": null} when no certificate with this name is installed

• Delete all CA certificates

  • Path: /api/ca_certificates
  • Method: DELETE
  • Minimum user role: admin
  • Response on success (200 OK): {"message": "Successfully deleted all CA certificates", "data": null}; succeeds also when nothing is installed

Back to Index