Certificates | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve a list of all the RAS Certificates.

Query parameters

SiteIdinteger · int32Optional

Site ID of which the Certificates will be retrieved (optional)

NamestringOptional

Filter the result by certificate name (optional)

Responses

application/json; api-version=1.0

object[]Optional

The Certificate

application/json; api-version=1.0

get

GET /api/Certificates HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-18T19:43:26.380Z",
    "timeLastMod": "2025-04-18T19:43:26.380Z",
    "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:43:26.380Z",
    "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"
  }
]

Get

get

Retrieve a specific RAS Certificate.

Path parameters

idinteger · int32Required

ID of the Certificate to be retrieved

Responses

application/json; api-version=1.0

objectOptional

The Certificate

application/json; api-version=1.0

get

GET /api/Certificates/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-18T19:43:26.380Z",
  "timeLastMod": "2025-04-18T19:43:26.380Z",
  "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:43:26.380Z",
  "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"
}

Delete

delete

Delete a RAS Certificate.

Path parameters

idinteger · int32Required

ID of the Certificate to be deleted

Responses

application/json; api-version=1.0

delete

DELETE /api/Certificates/{id} HTTP/1.1
Host: 
Accept: */*

No content

Update

put

Modify the properties of a RAS Certificate.

Path parameters

idinteger · int32Required

ID of the Certificate to be updated

Body

Update a certificate

namestring | nullableOptional

The new name of the target Certificate.

descriptionstring | nullableOptional

A user-defined Certificate description.

usagestring[Flag] · enumOptional

Certificate Usage Certificate Usage

Available options:

enabledboolean | nullableOptional

Enable or disable the specified Certificate in a site.

Responses

application/json; api-version=1.0

put

PUT /api/Certificates/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 97

{
  "name": "text",
  "description": "text",
  "usage": [
    "0 = None",
    "2 = Gateway",
    "4 = HALB"
  ],
  "enabled": true
}

No content