Apply Certificate

Look up the Certificate Profile matching the service-type and apply the certificate. When the Certificate Profile has cluster_certificate=false, the node_id parameter is required to designate the node where the certificate needs to be applied. Note that when applying CA-signed certificates to either the API certificate profile or the MGMT_CLUSTER certificate profile, the cerficate must have its CN or SAN extensions matching the endpoint's IP or FQDN. This also means that applying a CA-signed certificate to the MGMT_CLUSTER service profile to a cluster without first configuring its VIP is not allowed.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/trust-management/certificates/{cert-id}?action=apply_certificate

COPY

Path Parameters

string

cert-id

Required

ID of certificate to apply

Query Parameters

string

node_id

Optional

Constraints: maxLength: 255

Node Id

string

service_type

Required

Supported service types, that are using certificates.

Possible values are : MGMT_CLUSTER, MGMT_PLANE, API, NOTIFICATION_COLLECTOR, SYSLOG_SERVER, RSYSLOG_CLIENT, APH, APH_TN, GLOBAL_MANAGER, LOCAL_MANAGER, CLIENT_AUTH, RMQ, K8S_MSG_CLIENT, WEB_PROXY, CBM_API, CBM_CCP, CBM_CSM, CBM_MP, CBM_GM, CBM_AR, CBM_MONITORING, CBM_IDPS_REPORTING, CBM_CM_INVENTORY, CBM_MESSAGING_MANAGER, CBM_UPGRADE_COORDINATOR, CBM_SITE_MANAGER, CBM_CLUSTER_MANAGER, CBM_CORFU, COMPUTE_MANAGER, CCP, ANALYTICS_AGENT, ANALYTICS_KAFKA, NAPP_COMMON_AGENT, NAPP_PACE_AGENT, NAPP_METRICS_AGENT,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Operation doesn't return any data structure

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "error_code": 0,
    "error_data": {},
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_data": {},
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure

500

Returns InternalServerError of type(s) application/json

Operation doesn't return any data structure

503

Returns ServiceUnavailable of type(s) application/json

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/trust-management/certificates/{cert-id}?action=apply_certificate

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

System Administration Operations