Jump to

• Request
• Response

Get Broker Server Certificate Expiry Status

get

/api/broker/Servers/readServerCerts

Gets certificate expiration dates and warning status for the specified broker servers. The request accepts a comma-separated list of server IDs. Servers that do not respond before the API timeout are omitted from the response.

Request

Query Parameters

• ServerIDs(required): string
  Comma-separated broker server IDs.

  Example:

  1,2,3

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/brokerServersReadServerCerts"
                    }
                },
                "total":{
                    "description":"The total number of server certificate entries returned.",
                    "type":"integer",
                    "example":"2"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of server certificate entries returned.

  Example: 2

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/brokerServersReadServerCerts"
            }
        },
        "total":{
            "description":"The total number of server certificate entries returned.",
            "type":"integer",
            "example":"2"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServersReadServerCerts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/brokerServersReadServerCerts"
    }
}

Nested Schema : brokerServersReadServerCerts

Type: object

Show Source

• CertExpiryDates: string
  A JSON object string that contains certificate expiration dates for the server. Each object key is the certificate file name without the **.crt** extension, and each value is the expiration date.

  Example: {"Host":"2026-06-22","Web":"2026-09-30"}
• CertExpiryFlag: integer
  The highest certificate expiration warning state for the server. Allowed values are:

  • 0: No certificate has expired or reached the configured warning period.
  • 1: At least one certificate expires within the configured warning period.
  • 2: At least one certificate has expired.

  Example: 1
• CertExpiryStatus: string
  The warning message for certificates on the server that have expired or expire within the warning period (configured in the CertExpiryWarning global property). Can contain information about multiple certificates. Empty when no certificates require attention.

  Example: Host: cert has expired, Web: cert expires in 14 days
• ServerHostFQDN: string
  The server host FQDN.

  Example: server.com
• ServerID: integer
  The server ID.

  Example: 1

{
    "type":"object",
    "properties":{
        "ServerID":{
            "description":"The server ID.",
            "type":"integer",
            "example":"1"
        },
        "ServerHostFQDN":{
            "description":"The server host FQDN.",
            "type":"string",
            "example":"server.com"
        },
        "CertExpiryDates":{
            "description":"A JSON object string that contains certificate expiration dates for the server. Each object key is the certificate file name without the **.crt** extension, and each value is the expiration date.",
            "type":"string",
            "example":"{\"Host\":\"2026-06-22\",\"Web\":\"2026-09-30\"}"
        },
        "CertExpiryFlag":{
            "description":"The highest certificate expiration warning state for the server.\nAllowed values are:\n<ul><li><b>0</b>: No certificate has expired or reached the configured warning period.</li>\n<li><b>1</b>: At least one certificate expires within the configured warning period.</li>\n<li><b>2</b>: At least one certificate has expired.</li></ul>",
            "type":"integer",
            "example":"1"
        },
        "CertExpiryStatus":{
            "description":"The warning message for certificates on the server that have expired or expire within the warning period (configured in the <b>CertExpiryWarning</b> global property). Can contain information about multiple certificates. Empty when no certificates require attention.",
            "type":"string",
            "example":"Host: cert has expired, Web: cert expires in 14 days"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top