Skip to end of metadata
Go to start of metadata

REST API Method: POST /rest/csr?action=generate

This resource defines the generate action on the CSR Resource . It returns the CSR as the response.


HTTP Method


Requires Authentication:



Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
commonNameYesNostringnone64 - Max Length The commonName can be hostname or FQDN. In general, it should be an FQDN. The default is set as the localhost string.
sanDNSNoNostringnone255 - Max Length The Subject Alternative Name DNS should be used when the FQDN is greater than 64 chars for a common name.
emailAddressNoNostringnone128 - Max Length Indicates the e-mail address of a contact person who is responsible for the managing the device.
countryNameNoNostringnone2 - Max Length Specifies the International Organization for Standardization (ISO) format country code for the country in which your organization is legally registered. Default setting is United States.
stateOrProvinceNameNoNostringnone128 - Max Length Specifies the state, province, region, territory as a full name of where your organization is located. Do not abbreviate.
localityNameNoNostringnone128 - Max Length Specifies the name of the city/locality field in which your organization is registered and located. Do not abbreviate.
organizationNameNoNostringnone64 - Max Length Specifies the organization name under which your business is legally registered.
organizationalUnitNameNoNostringnone64 - Max Length Specifies the division within the organization, for example: "Engineering" or "Human Resources".
keyBitLengthNoNoEnum1024Possible values:
  • 1024 - r1024
  • 2048 - r2048
Specifies the key size to use when generating the Certificate Signing Request public and private key pair.

When deciding what size key to use, consideration should be given to your security requirements such as what data is to be protected and what threats it may be exposed to. The larger the key, the greater the security it provides, but also the slower the cryptographic operations which may take from few seconds to several minutes.

  • No labels