REST API - gen

vcenter certificate authority certificate: gen cert

Get the signed certificate for the given Spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/certificate-authority/certificate?action=gen-cert

Request Body Structure:

{
    "spec" : {
        "state_or_province" : "string",
        "country" : "string",
        "hostname" : "string",
        "email_address" : "string",
        "organization" : "string",
        "locality" : "string",
        "ip_address" : "string",
        "validity" : 1,
        "common_name" : "string",
        "key_size" : 1,
        "organization_unit" : "string"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	spec	The information needed to generate the signed certificate.
spec.key_size	long	The size of the key to be used for public and private key generation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset the key size will be '2048'.
spec.common_name	string	The common name of the host for which certificate is generated. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.organization	string	Organization field in certificate subject. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.organization_unit	string	Organization unit field in certificate subject. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.locality	string	Locality field in certificate subject. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.state_or_province	string	State field in certificate subject. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.country	string	Country field in certificate subject. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.email_address	string	Email field in Certificate extensions. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.ip_address	string	IPAddress of the of the host for which certificate is generated. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset IPAddress will not be included in SAN.
spec.hostname	string	Hostname field in Certificate extensions. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.validity	long	Validity field takes as input the number of years for which the generated certificate is to be made valid. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset validity will be set as 2 years.

Response:

HTTP Status Code: 200

Representation:

{
"value" : "string"
}

Response Type:

Name	Type	Description
bold = required
value	string	Signed certificate in String format.

Errors:

HTTP Status Code	Type	Description
400	invalid_argument	if provided argument is not correct.
500	internal_server_error	if error happen on server side.
500	error	If the system failed to return the signed certificate.