Certificates

PreviousWorkspace NextExport

Last updated 1 year ago

Was this helpful?

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Certificates'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-03-25T22:03:36.539Z",
    "timeLastMod": "2025-03-25T22:03:36.539Z",
    "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-25T22:03:36.539Z",
    "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"
  }
]

Success

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

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Certificates/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-25T22:03:36.539Z",
  "timeLastMod": "2025-03-25T22:03:36.539Z",
  "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-25T22:03:36.539Z",
  "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"
}

Success

Delete

delete

Delete a RAS Certificate.

Path parameters

idinteger · int32required

ID of the Certificate to be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Certificates/{id}'

204

401

404

No body

No Content

Update

put

Modify the properties of a RAS Certificate.

Path parameters

idinteger · int32required

ID of the Certificate to be updated

Body

namestring | nullableoptional

The new name of the target Certificate.

descriptionstring | nullableoptional

A user-defined Certificate description.

usagestring[Flag] · enumoptional

Certificate Usage Certificate Usage

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

enabledboolean | nullableoptional

Enable or disable the specified Certificate in a site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Certificates/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "description": "text",
    "usage": [
      "0 = None",
      "2 = Gateway",
      "4 = HALB"
    ],
    "enabled": true
  }'

204

401

404

No body

No Content