Generate Request

Generate Request

post

Generate a new Certificate Request.

Body

Generate a certificate request

namestring | nullableRequired

The name of the target Certificate.

siteIdinteger · int32Optional

Site ID in which to add the Certificate.

descriptionstring | nullableOptional

A user-defined Certificate description.

usagestring[Flag] · enumOptional

Certificate Usage Certificate Usage

Available options:

enabledbooleanOptional

Whether to enable or disable the certificate being created.

keySizestring · enumOptional

Certificate Key Size Certificate Key Size

Available options:

countryCodestring | nullableOptional

The Country Code for the certificate to be generated. By default, the country code from the PowerShell region information is used.

fullStateOrProvincestring | nullableOptional

The Full State or Province for the certificate to be generated.

citystring | nullableOptional

The City for the certificate to be generated.

organisationstring | nullableOptional

The Organisation for the certificate to be generated.

organisationUnitstring | nullableOptional

The Organisation Unit for the certificate to be generated.

emailstring | nullableRequired

The Email for the certificate to be generated.

commonNamestring | nullableRequired

The Common Name for the certificate to be generated.

alternateNamesstring | nullableOptional

The Alternate Names for the certificate to be generated. eg. IP:1.2.3.4,DNS:example.com

Responses

application/json; api-version=1.0

objectOptional

The Certificate

application/json; api-version=1.0

application/json; api-version=1.0

post

HTTPcURLJavaScriptPython

POST /api/Certificates/GenerateRequest HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 403

{
  "name": "text",
  "siteId": 1,
  "description": "text",
  "usage": [
    "0 = None",
    "2 = Gateway",
    "4 = HALB"
  ],
  "enabled": true,
  "keySize": [
    "0 = KeySize1024",
    "1 = KeySize2048",
    "2 = KeySize4096",
    "3 = KeySize3072",
    "4 = KeySize521",
    "255 = KeySizeUnknown"
  ],
  "countryCode": "text",
  "fullStateOrProvince": "text",
  "city": "text",
  "organisation": "text",
  "organisationUnit": "text",
  "email": "text",
  "commonName": "text",
  "alternateNames": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-18T19:44:08.657Z",
  "timeLastMod": "2025-04-18T19:44:08.657Z",
  "status": [
    "0 = Valid",
    "1 = Expiring",
    "2 = Expired",
    "3 = InProgress",
    "4 = Revoked",
    "5 = Issuing",
    "6 = IssuingFailed",
    "7 = Renewing",
    "8 = RenewingFailed",
    "9 = Revoking",
    "10 = RevokingFailed"
  ],
  "publicKey": "text",
  "expirationDate": "2025-04-18T19:44:08.657Z",
  "keySize": [
    "0 = KeySize1024",
    "1 = KeySize2048",
    "2 = KeySize4096",
    "3 = KeySize3072",
    "4 = KeySize521",
    "255 = KeySizeUnknown"
  ],
  "commonName": "text",
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "type": [
    "0 = SelfSigned",
    "1 = Request",
    "2 = Imported",
    "3 = LetsEncrypt"
  ],
  "usage": [
    "0 = None",
    "2 = Gateway",
    "4 = HALB"
  ],
  "intermediate": "text",
  "request": "text",
  "description": "text",
  "alternateNames": "text"
}