Import Certificate

PreviousGenerate Self Signed NextImport Pfx

Last updated 11 months ago

Was this helpful?

Import a Certificate

This can be used to import a new Certificate file.

post

/api/Certificates/ImportCertificate

Body

CertificateFilestring · binary

Certificate file to be uploaded.

PrivateKeyFilestring · binary

Privatekey file to be uploaded.

Namestring

The name of the target Certificate

SiteIdinteger · int32

Site ID in which to add the Certificate

Descriptionstring

A user-defined Certificate description

Usagestring[Flag] · enum

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

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

Enabledboolean

Whether to enable or disable the certificate being created

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Certificates/ImportCertificate' \
  --header 'Content-Type: multipart/form-data' \
  --form 'CertificateFile=text' \
  --form 'PrivateKeyFile=text' \
  --form 'Name=text' \
  --form 'SiteId=1' \
  --form 'Description=text' \
  --form 'Usage=0 = None,2 = Gateway,4 = HALB' \
  --form 'Enabled=true'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-15T18:36:56.080Z",
  "timeLastMod": "2025-03-15T18:36:56.080Z",
  "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-15T18:36:56.080Z",
  "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