Upload SSL Certificate and Private Key

post

http://127.0.0.1:8080/gms/httpsCertificate

Uploads and installs an SSL certificate, private key, and optional intermediate certificate chain for the Orchestrator's HTTPS configuration. The certificate is stored in a BCFKS keystore and applied to NGINX for HTTPS.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

SSL certificate data including the certificate, private key, and optional intermediate certificate chain in Base64-encoded format.

Request parameters for SSL certificate validation. Supports PEM and PFX/PKCS#12 formats with RSA or ECDSA keys.

certificateData

string

required

Base64-encoded X.509 certificate with data URI prefix. For PEM format, must contain '-----BEGIN CERTIFICATE-----'. Supported algorithms: RSA, ECDSA with SHA256/SHA384/SHA512.

keyData

string

Base64-encoded private key with data URI prefix. Required for PEM certificates (not needed for PFX). Supports PKCS#1, PKCS#8, and EC private key formats.

intermediateCertFileContent

string

Base64-encoded intermediate CA certificate chain for establishing trust to root CA. Optional for validation.

password

string

Password for PFX/PKCS#12 file decryption. Required when isPFX is true.

passPhrase

string

Passphrase for encrypted PEM private keys. Required when keyData contains 'ENCRYPTED' marker.

isPFX

boolean

Defaults to false

Set to true for PFX/PKCS#12 certificate bundles. When true, certificateData contains the complete bundle and keyData can be empty.

isSslCACert

boolean

Defaults to false

Set to true for CA certificates. When true, private key validation is skipped.

isEncrypted

boolean

Defaults to false

Indicates if the request payload uses client-side encryption with the randomizer field.

randomizer

string

Random string for client-side encryption. Required when isEncrypted is true.

Responses

204

Certificate uploaded and installed successfully. The action is logged in the system action log.

401

Unauthorized - Authentication required or invalid credentials.

403

Forbidden - User lacks READ_WRITE permission.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request - Invalid certificate data, key format, or unsupported certificate type.

500Internal server error - Failed to update keystore or write certificate files.