Generate Csr

Generate Csr

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

Request
URI
POST
https://{api_host}/appliance/certificates/actions/generate-csr
COPY
Request Body

Certificate signing request settings.

CertificateSigningRequestInputData of type(s) application/json
Optional 
{
    "common_name": "string",
    "organization": "VMware",
    "organization_unit": "VMware organization unit",
    "fqdn": "string",
    "ip": "10.20.11.15, 10.20.11.26",
    "locality": "Palo Alto",
    "state": "California",
    "country": "US",
    "email": "admin@vmware.com"
}
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
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
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
state
Optional

The state or province where organization is legally located. Do not use an abbreviation. If not set, VMware default is 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.

Authentication
This operation uses the following authentication methods.
Responses
200

Generated certificate signing request (CSR).

Returns CertificateSigningRequestDataDrResponseEntity of type(s) application/json
This response body class contains all of the following: CertificateSigningRequestData 
{
    "value": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
Metadata
_meta
Optional

_meta


400

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

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json 
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


On This Page
Certificates Operations
POST
Add Ca Certificates
POST
Delete Ca Certificates
POST
Generate Csr
GET
Get Appliance Ca Certificates
GET
Get Appliance Certificate
POST
Probe Ssl
POST
Update Appliance Certificate