Apply Server Certificate

Apply Server Certificate
Apply HCX Manager Server Certificate

Applies SSL/TLS certificate and private key for the HCX Manager's HTTPD web server. This certificate is used for HTTPS connections to the HCX Manager.

Important Notes:

  • Validates certificate and private key format
  • If private key is not provided, uses the private key from the last CSR generation
  • Applies certificate with graceful Apache restart (no service interruption)

Certificate Format:

  • Must be X.509 certificates in PEM format
  • Can include certificate chain (intermediate + leaf certificates)
  • Private key must match the certificate's public key
Request
URI
PUT
https://{server}:9443/api/admin/certificates/serverCertificate/httpd
COPY
Request Body

Show optional properties

{
    "sslCert": "string"
}
{
    "sslCert": "string",
    "sslCertKey": "string"
}
string
sslCert
Required

SSL certificate in PEM format (can include certificate chain)

string
sslCertKey
Optional

Private key in PEM format (optional - uses CSR-generated key if omitted)

Authentication
This operation uses the following authentication methods.
Responses
202

Certificate applied successfully (async operation accepted)

Returns CertificateRestResponse of type(s) application/json
{
    "success": true,
    "completed": true,
    "time": 1753094523000,
    "version": "1.0",
    "protocol": "string",
    "fingerprint": "string",
    "data": {
        "items": [
            {}
        ]
    },
    "errors": [
        {
            "text": "string"
        }
    ],
    "warnings": [
        {
            "text": "string"
        }
    ]
}
boolean
success
Required

Indicates if the operation was successful

boolean
completed
Required

Indicates if the operation completed

integer As int64 As int64
time
Required

Unix timestamp in milliseconds

string
version
Optional

API version

string
protocol
Optional

Protocol version

string
fingerprint
Optional

Response fingerprint

object
data
Optional

Response data containing items array

array of object
errors
Optional

Array of error objects

array of object
warnings
Optional

Array of warning objects


400

Bad request - Invalid certificate format or validation failure

Returns ErrorResponse of type(s) application/json
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error

Returns ErrorResponse of type(s) application/json
{
    "isSuccess": false,
    "message": "Error in applying server certificate, please verify the certificates again.",
    "httpStatusCode": 500
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"sslCert":"string"}' https://{api_host}/api/admin/certificates/serverCertificate/httpd