HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. customCerts

Add or update custom CA certificate

post
http://127.0.0.1:8080/customCert

Creates a new custom CA certificate or updates an existing one. The certificate is validated before storage: it must be a valid X.509 CA certificate with Basic Constraints CA flag set to true. After successful operation, an alarm is raised indicating Orchestrator restart is required for changes to take effect. A certificate expiration check job is triggered to verify if certificates are expiring within 60 days.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Custom CA certificate to add or update. Include the PEM-encoded certificate, the appliance sync status and a unique alias. The id is required for update operation.

Custom CA Certificate object used for input operation while inserting/updating a certificate (POST).

integer

Unique identifier for the certificate. Required for updates, auto-generated for new certificates.

string
required

User-defined alias to identify the CA certificate. Must be unique across all certificates.

string
required

The CA certificate in PEM format (Base64 encoded). Must be a valid X.509 CA certificate with Basic Constraints CA flag set to true.

int64

Unix timestamp (in seconds) of the last certificate update in Orchestrator.

int32
required
0 to 3

The appliance sync status represents a certificate's synchronization status indicated as an integer - 0:Deployed, 1:Deployment pending, 2:Withdrawn, 3:Withdrawal pending. These states indicate whether the certificate is currently deployed on appliances, pending deployment, withdrawn from appliances, or pending withdrawal.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 12 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 12 hours ago

Did this page help you?