Generate Request

PreviousGenerate Lets Encrypt NextGenerate Self Signed

Last updated 12 months ago

Was this helpful?

Generate Request

post

Generate a new Certificate Request.

Body

namestring | nullablerequired

<para type="description">The name of the target Certificate.</para>

siteIdinteger · int32

<para type="description">Site ID in which to add the Certificate.</para>

descriptionstring | nullable

<para type="description">A user-defined Certificate description.</para>

usagestring[Flag] · enum

<para type="description">Certificate Usage</para> <para type="synopsis">Certificate Usage</para>

Options: 0 = None,2 = Gateway,4 = HALB

enabledboolean

<para type="description">Whether to enable or disable the certificate being created.</para>

keySizestring · enum

<para type="description">Certificate Key Size</para> <para type="synopsis">Certificate Key Size</para>

Options: 0 = KeySize1024,1 = KeySize2048,2 = KeySize4096,3 = KeySize3072,4 = KeySize521,255 = KeySizeUnknown

countryCodestring | nullable

<para type="description">The Country Code for the certificate to be generated.</para> <para type="description">By default, the country code from the PowerShell region information is used.</para>

fullStateOrProvincestring | nullable

<para type="description">The Full State or Province for the certificate to be generated.</para>

citystring | nullable

<para type="description">The City for the certificate to be generated.</para>

organisationstring | nullable

<para type="description">The Organisation for the certificate to be generated.</para>

organisationUnitstring | nullable

<para type="description">The Organisation Unit for the certificate to be generated.</para>

emailstring | nullablerequired

<para type="description">The Email for the certificate to be generated.</para>

commonNamestring | nullablerequired

<para type="description">The Common Name for the certificate to be generated.</para>

alternateNamesstring | nullable

<para type="description">The Alternate Names for the certificate to be generated.</para> <para type="description">eg. IP:1.2.3.4,DNS:example.com</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Certificates/GenerateRequest' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-21T05:28:22.352Z",
  "timeLastMod": "2025-03-21T05:28:22.352Z",
  "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-03-21T05:28:22.352Z",
  "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"
}

Created