[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrs-appliance-config-api

Generate CSR

Description

Generate a new key and certificate signing request (CSR) and return it for signing.

Request

Request

URL

URL


post
https://{api_host}//appliance/certificates/actions/generate-csr
Copy

Request Body

Request Body

CertificateSigningRequestInputData of mimetype application/json Optional

Certificate signing request settings.

{
    "country": "US",
    "email": "admin@vmware.com",
    "ip": "10.20.11.15, 10.20.11.26",
    "locality": "Palo Alto",
    "organization": "VMware",
    "organization_unit": "VMware organization unit",
    "state": "California"
}
string
common_name Optional

Common name to be set in CSR. Usually, it is the fully qualified domain name for the server. If not set, data provided in FQDN (OS hostname) will be used.


string
country Optional

The two-letter ISO abbreviation for organization country. If not set, ‘US’ default is used.


string
email Optional

An email address to contact the organization. Will be empty, if not set.


string
fqdn Optional

A list of comma-separated FQDN strings to be used for SAN extensions. If not set, OS hostname is used.


string
ip Optional

A list of comma-separated IP strings to be used for SAN extensions. Will be empty, if not set.


string
locality Optional

The city where organization is legally located. If not set, VMware default will be used.


string
organization Optional

The exact legal name of your organization. Do not use an abbreviation. If not set, VMware default is used.


string
organization_unit Optional

Section of the organization. If not set, VMware default is used.


string
state Optional

The state or province where organization is legally located. Do not use an abbreviation. If not set, VMware default is used.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns CertificateSigningRequestDataDrResponseEntity of type application/json

Generated certificate signing request (CSR).

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"value": "string"
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"country":"US","email":"admin@vmware.com","ip":"10.20.11.15, 10.20.11.26","locality":"Palo Alto","organization":"VMware","organization_unit":"VMware organization unit","state":"California"}' https://{api_host}/appliance/certificates/actions/generate-csr


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vrs-appliance-config-api
Feedback

Was this page helpful?