Certificates

List

Retrieve a list of all the RAS Certificates.

GET/api/Certificates

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

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

commonNamenullable string

The common name of the certificate.

namenullable string

Certificate Name.

siteIdinteger (int32)

ID of the site.

enabledboolean

Whether the certificate is enabled or not.

typeCertificateType (enum)

Certificate Type Certificate Type

0 = SelfSigned,1 = Request,2 = Imported,3 = LetsEncrypt

usageCertificateUsages (enum)

Certificate Usage Certificate Usage

0 = None,2 = Gateway,4 = HALB

intermediatenullable string

The intermediate.

requestnullable string

The certificate request.

descriptionnullable string

The description of the certificate.

alternateNamesnullable string

The alternate names of the certificate.

Request

JavaScriptCurlPython

const response = await fetch('/api/Certificates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:43:25.472Z",
    "timeLastMod": "2024-11-07T07:43:25.472Z",
    "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": "2024-11-07T07:43:25.472Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text",
    "name": "text",
    "enabled": false,
    "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

Retrieve a specific RAS Certificate.

GET/api/Certificates/{id}

Path parameters

id*integer (int32)

ID of the Certificate to be retrieved

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

statusCertificateStatus (enum)

Certificate Status Certificate Status

0 = Valid,1 = Expiring,2 = Expired,3 = InProgress,4 = Revoked,5 = Issuing,6 = IssuingFailed,7 = Renewing,8 = RenewingFailed,9 = Revoking,10 = RevokingFailed

publicKeynullable string

The public key.

expirationDatenullable string (date-time)

The expiration date of the certificate.

keySizeCertificateKeySize (enum)

Certificate Key Size Certificate Key Size

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

commonNamenullable string

The common name of the certificate.

namenullable string

Certificate Name.

siteIdinteger (int32)

ID of the site.

enabledboolean

Whether the certificate is enabled or not.

typeCertificateType (enum)

Certificate Type Certificate Type

0 = SelfSigned,1 = Request,2 = Imported,3 = LetsEncrypt

usageCertificateUsages (enum)

Certificate Usage Certificate Usage

0 = None,2 = Gateway,4 = HALB

intermediatenullable string

The intermediate.

requestnullable string

The certificate request.

descriptionnullable string

The description of the certificate.

alternateNamesnullable string

The alternate names of the certificate.

Request

JavaScriptCurlPython

const response = await fetch('/api/Certificates/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:43:25.472Z",
  "timeLastMod": "2024-11-07T07:43:25.472Z",
  "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": "2024-11-07T07:43:25.472Z",
  "keySize": [
    "0 = KeySize1024",
    "1 = KeySize2048",
    "2 = KeySize4096",
    "3 = KeySize3072",
    "4 = KeySize521",
    "255 = KeySizeUnknown"
  ],
  "commonName": "text",
  "name": "text",
  "enabled": false,
  "type": [
    "0 = SelfSigned",
    "1 = Request",
    "2 = Imported",
    "3 = LetsEncrypt"
  ],
  "usage": [
    "0 = None",
    "2 = Gateway",
    "4 = HALB"
  ],
  "intermediate": "text",
  "request": "text",
  "description": "text",
  "alternateNames": "text"
}

Update

Modify the properties of a RAS Certificate.

PUT/api/Certificates/{id}

Path parameters

id*integer (int32)

ID of the Certificate to be updated

Body

application/json; api-version=1.0

The Certificate to be updated

namenullable string

The new name of the target Certificate.

descriptionnullable string

A user-defined Certificate description.

usageCertificateUsages (enum)

Certificate Usage Certificate Usage

0 = None,2 = Gateway,4 = HALB

enablednullable boolean

Enable or disable the specified Certificate in a site.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Certificates/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a RAS Certificate.

DELETE/api/Certificates/{id}

Path parameters

id*integer (int32)

ID of the Certificate to be deleted

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Certificates/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}