POST /staged_config/certificates/certificate_signing_request

Edit online

Creates a new Certificate Signing Request (CSR) file. A private key is generated and used to create the CSR file. The private key is kept secure on the Console. Use the GET call to download the CSR file. You must have System Administrator or Security Administrator permissions to use this endpoint.

Table 1. POST /staged_config/certificates/certificate_signing_request resource details
MIME Type

text/plain

Table 2. POST /staged_config/certificates/certificate_signing_request request body details
Parameter Data Type MIME Type Description Sample

CSRModel

Object

application/json
The new certificate resource object. This JSON object contains the following parameters:
  • key_size - Private key length, in bits. The default is 2048.
  • description - Description of the Certificate Signing Request (CSR).
  • purpose - (Required) Indicates the intended use of the certificate that is generated from this CSR.

    To use the certificate as a server certificate, type "SERVER".

    To use it as a client certificate, type "CLIENT".

    To use it as both a server and client certificate, type "SERVER_CLIENT".

    To use it for encrypting data only, type "SIGNING_ENCRYPTION".

  • country_name - C- Two-letter code for the country where the organization is located.
  • state_province - ST- The state or region where the organization is located.
  • locality - L- The city where the organization is located.
  • organization_name - O- The legal name of the organization.
  • organizational_unit - OU- The division of the organization that is handling the certificate.
  • common_name -(Required) CN- The fully qualified domain name of the resource that the certificate will protect.
  • street_address - STREET- Street address of the requester.
  • domain_component - DC- The domain component.
  • user_id - UID- The user ID of the requester.
  • dns - Subject Alternative Name - DNS extension list.
  • ip_addresses - Subject Alternative Name - IP Addresses extension list.
  • emails - Subject Alternative Name - Email addresses extension list.
  • uri_list - Subject Alternative Name - URIs extension list.

{ "common_name": "String", "country_name": "String", "description": "String", "dns": [ "String" ], "domain_component": "String", "emails": [ "String" ], "id": 42, "ip_addresses": [ "String" ], "key_size": 42, "locality": "String", "organization_name": "String", "organizational_unit": "String", "purpose": "String", "state_province": "String", "street_address": "String", "uri_list": [ "String" ], "user_id": "String" }
Table 3. POST /staged_config/certificates/certificate_signing_request response codes
HTTP Response Code Unique Code Description

201

The Certificate Signing Request (CSR) was created successfully.

422

1032

null

422

1033

null

422

1034

null

422

1035

null

422

1036

null

422

1037

null

422

1038

null

422

1039

null

422

1040

null

422

1041

null

422

1042

null

500

1020

null

500

1030

null

Response Description

The location header of the newly created resource.
  • id - Uniquely identifies the Certificate Signing Request (CSR).

Response Sample


42