Acquire system settings (notifications)

This is an API function to acquire information of the notification settings from the system settings. This API function corresponds to the operation on the screen that is displayed by clicking the [Notification] tab after selecting the [System Settings] from the [user-name] button that is displayed on the right-top of the operation screen of Manager.

= Remarks =

The response parameters of the following API functions are the same. (/api/v1/system-settings/notifications)

  • Acquire system settings (notifications)
  • Modify system settings (notifications)
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/system-settings/notifications'
Request parameter
A request parameter is not required.
Response
{
  "settings": {
     "agentOfflineSettings": {
        "cron": "string",
        "enableNotification": true,
        "offlineTime": 0
     },
     "mailSettings": {
        "address": "string",
        "cc": "string",
        "enableNotification": true,
        "subjectPrefix": "string"
     },
     "receiveLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     },
     "termKeyExpirationSettings": {
        "beforeDays": 0,
        "cron": "string",
        "enableNotification": true
     },
     "traceLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     },
     "transferLogErrorSettings": {
        "cron": "string",
        "enableNotification": true
     }
  }
}
Response parameter
Item name Response parameter Type Value
Agent offline notification schedule settings agentOfflineSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Agent offline notification (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off

Agent offline notification threshold

 offlineTime Integer

The time when an email will be sent after a session between Manager and an instance of Agent becomes offline is returned by using the number of minutes.

Address (To)

 mailSettings address String  

Address (Cc)

 cc String  

To send an email (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off
Subject prefix subjectPrefix String  
Receive log error notification schedule

receiveLogErrorSettings

 cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Receive log error notification (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off

Term License Key expiration notification threshold

 termKeyExpirationSettings beforeDays Integer

The day when an email will be sent is returned by using the number of days before the term of license is expired.
Term License Key expiration notification schedule cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Term License Key expiration notification (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off
Trace log error notification schedule traceLogErrorSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Trace log error notification (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off
Transfer log error notification schedule transferLogErrorSettings cron String

"second minute hour day month day-of-week" (Example: 0 0 10-18 * * MON-FRI)

Other than the addition of seconds at the beginning, this format is the same as the standard cron format.

Transfer log error notification (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off