[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform

Update Certificate

Description

Update an existing certificate or a chain of certificates (CAs) and, optionally, a private key that can be applied to the K8S Platform CA certificat. The certificate and the key should be stored in PEM format. If certificate is applied for Entity type NAPP_PLATFORM_CA, private key is mandatory.

Request

Request

URL

URL


put
https://api_host/napp/api/v1/platform/trust-management/certificates
Copy

Request Body

Request Body

CertificateData of type(s) application/json Required

The certificate to import in the truststore.

{}
#definitions/EntityType
used_by Required

Entity that use this Certificate


#definitions/CertificateDetail
details Optional

expand the pem data and show all its details.


string
passphrase Optional

Password for private key encryption.


string
pem_encoded Optional

Pem encoded certificate data.


string
private_key Optional

Private key data.


boolean
skip_sync_services Optional

Skip synchronizing services after certificate change. User such as nsx-config can change multiple certificates without synchronizing services and synchronizes services in the last call.


string
alias Optional

Alias of the Certificate; Unique identifier of this certificate under a Certificate Entity.


string
uuid Optional

UUID of the certificate. Generated on k8s platform. If given in post request, the API will return bad request.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns CertificateData of type(s) application/json

OK and Certificate content

{
	"alias": "string",
	"passphrase": "string",
	"pem_encoded": "string",
	"private_key": "string",
	"skip_sync_services": false,
	"uuid": "string"
}
#definitions/EntityType
used_by Required

Entity that use this Certificate


#definitions/CertificateDetail
details Optional

expand the pem data and show all its details.


string
passphrase Optional

Password for private key encryption.


string
pem_encoded Optional

Pem encoded certificate data.


string
private_key Optional

Private key data.


boolean
skip_sync_services Optional

Skip synchronizing services after certificate change. User such as nsx-config can change multiple certificates without synchronizing services and synchronizes services in the last call.


string
alias Optional

Alias of the Certificate; Unique identifier of this certificate under a Certificate Entity.


string
uuid Optional

UUID of the certificate. Generated on k8s platform. If given in post request, the API will return bad request.

Errors

Errors

400

Unknown backend error

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"alias":"string","passphrase":"string","pem_encoded":"string","private_key":"string","skip_sync_services":false,"uuid":"string"}' https://api_host/napp/api/v1/platform/trust-management/certificates


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform
Feedback

Was this page helpful?