/mgmt/config/default/CertMonitor GET

Use the HTTP GET method with the /mgmt/config/default/CertMonitor resource to request a list of current appliance certificate monitor settings.

Resource URL

https://host:port/mgmt/config/default/CertMonitor
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes the following fields:
mAdminState
String.
The administrative state of the certificate monitor settings, can be one of the following values:
  • enabled
  • disabled
PollingInterval
Integer.
How often the certificate monitor scans expiration date in number of days. The default is 1 (scans every day).
ReminderTime
Integer.
The notification window before certificate expiration to start certificate expiration messages. Set in number of days. Defaults to 30 (specifies that all certificates to expire in 30 days or less generate a log message).
LogLevel
String.
The priority for certificate monitor log entries that note the impending expiration date of a certificate. Can be set to one of the following values, the default is warn.
emerg
Indicates emergency.
alert
Indicates alert.
critic
Indicates critical.
error
Indicates error.
warn
Indicates warn.
notice
Indicates notice.
info
Indicates information.
debug
Indicates debug.
DisableExpiredCerts
String.
Set to "on" or "off". Set to "on" to prevent the use of expired certificates either directly or through inheritance. . The default value is "off". This setting applies only to system certificates (for example, for the web UI), it has no affect on queue manager certificates.

Examples

The following example requests the file system usage monitor information on the appliance:

The following URL is used with the HTTP GET method:
GET /mgmt/config/default/CertMonitor
The following listing shows the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/config/default/CertMonitor/Certificate%20Monitor"
    },
    "doc": {
      "href": "/mgmt/docs/config/CertMonitor"
    }
  },
  "CertMonitor": {
    "name": "Certificate Monitor",
    "mAdminState": "enabled",
    "PollingInterval": 1,
    "ReminderTime": 30,
    "LogLevel": "warn",
    "DisableExpiredCerts": "off"
  }
}