REST API - get
  1. Operations
  2. esx
  3. kms
  4. providers
  5. client certificate
  6. csr

esx kms providers client certificate csr: get

Get existing certificate signing request (CSR) for the client certificate and optionally the private key.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

Request:

HTTP request

GET https://{server}/api/esx/kms/providers/{provider}/client-certificate/csr

?include_private_key={true}

Path Parameters

Name Type Description
Required
provider string Identifier of the provider.

Query Parameters:

Name Type Description
bold = required
include_private_key boolean Include private key.

Optional. If unset the private key will not be included.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "csr" : "string",
    "private_key" : "secret string"
}

Headers:

None

Type:

Name Type Description
bold = required
- info A structure containing the CSR.
-.csr string Certificate Signing Request.

PEM format.
-.private_key secret Private key.

PEM format.

Optional. If unset, privateKey won't have key data.

Errors:

HTTP Status Code Type Description
400 invalid_argument if the provider Id is empty.
404 not_found if the provider not found.
401 unauthenticated if the caller is not authenticated.
403 unauthorized if the caller is not authorized.
500 error if any other error occurs.