NSX-T Data Center Global Manager REST API

Get the certificate profile for the given service type

Get an available certificate profile.
Note that not every service type has an active certificate profile.

Request:

Method:

GET

URI Path(s):

/api/v1/trust-management/certificate-profile/{service-type}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/trust-management/certificate-profiles/MGMT_CLUSTER

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

CertificateProfile+

CertificateProfile (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
abort_on_error	Abort when there's an error If this field is true, the certificate batch operation would be aborted if an error occurs during the replacement operation for this certificate profile.	boolean	Readonly
affected_services	Affected Services A comma-separated list of service names that may be affected/interrupted when replacing the certificate for this service-type.	string	Readonly
certificate_class	Category Service-types that are in a 'class'' cannot be share a certificate with a service in another 'class'.	CertificateClass	Readonly
cluster_certificate	Cluster Certificate True if this is for a cluster certificate	boolean	Required Readonly
deprecated_in_version	Deprecated in version Version in which this certificate profile was deprecated.	string	Readonly
description	Description A longer description what the service-type is used for.	string	Readonly
extended_key_usage	Extended Key Usage Indicating whether this certificate is used for server-auth, client-auth or both.	array of CertificateUsageType	Required Readonly
node_type	Node Type List of types of node this certificate applies to.	array of NodeType	Required Readonly
processing_order	Processing Order The order in which service-type certificates are replaced in a batch-replace.	integer	Readonly
profile_name	Certificate Profile Name	string	Required Readonly
replacement_duration	Processing Duration The estimated amount of time it takes to replace the certificate for this service-type, in seconds.	integer	Readonly
requires_private_key	Requires Private Key True if this certificate needs a private key.	boolean	Required Readonly
service_type	Unique Service Type A short and unique name for the type of service this certificate is used for.	ServiceType	Required Readonly
summary	Summary A short phrase what this service-type is for.	string	Readonly
unique_use	Unique Use True if the certificate used for this service-type cannot be used anywhere else.	boolean	Required Readonly

Example Response:

{ "profile_name": "Cluster Certificate Profile", "service_type": "MGMT_CLUSTER", "extended_key_usage": ["SERVER"], "unique_use": "false", "cluster_certificate": "true", "node_types": ["nsx-manager"] }

Required Permissions:

read

Feature:

trust_certificates

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable