Generate Self Signed

PreviousGenerate Request NextImport Certificate

Last updated 10 months ago

Was this helpful?

Generate Self Signed

Generate a new Self Signed Certificate.

post

/api/Certificates/GenerateSelfSigned

Body

namenullable stringrequired

The name of the target Certificate.

siteIdinteger int32

Site ID in which to add the Certificate.

descriptionnullable string

A user-defined Certificate description.

usageenum

Certificate Usage Certificate Usage

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

enabledboolean

Whether to enable or disable the certificate being created.

keySizeenum

Certificate Key Size Certificate Key Size

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

countryCodenullable string

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

expireInMonthsinteger int32

Specifies the length of validity of the certificate being generated.

fullStateOrProvincenullable string

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

citynullable string

The City for the certificate to be generated.

organisationnullable string

The Organisation for the certificate to be generated.

organisationUnitnullable string

The Organisation Unit for the certificate to be generated.

emailnullable stringrequired

The Email for the certificate to be generated.

commonNamenullable stringrequired

The Common Name for the certificate to be generated.

alternateNamesnullable string

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

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Certificates/GenerateSelfSigned' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{"name":"text","usage":["0 = None","2 = Gateway","4 = HALB"],"keySize":["0 = KeySize1024","1 = KeySize2048","2 = KeySize4096","3 = KeySize3072","4 = KeySize521","255 = KeySizeUnknown"],"email":"text","commonName":"text"}'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-11T08:10:42.659Z",
  "timeLastMod": "2025-02-11T08:10:42.659Z",
  "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-02-11T08:10:42.659Z",
  "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