Modify system settings (notifications)

This is an API function to modify the notification settings of 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 PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/system-settings/notifications'
Request body (JSON format)
{
  "settings": {
     "agentOfflineSettings": {
        "enableNotification": true,
        "offlineTime": 0
     },
     "mailSettings": {
        "address": "string",
        "cc": "string",
        "enableNotification": true,
        "subjectPrefix": "string"
     },
     "receiveLogErrorSettings": {
        "enableNotification": true
     },
     "termKeyExpirationSettings": {
        "enableNotification": true,
        "beforeDays": 0
     },
     "traceLogErrorSettings": {
        "enableNotification": true
     },
     "transferLogErrorSettings": {
        "enableNotification": true
     }
  }
}
Request Parameter (JSON format)
Item name Request parameter Type Value Default value

Agent offline notification (ON/OFF)

 settings agentOfflineSettings enableNotification Boolean

•　true: On

•　false: Off

  

Agent offline notification threshold

 offlineTime Integer

0 to 59 (minutes)

Specify when the notification email will be sent by using the number of minutes after a session between Manager and an instance of Agent becomes offline.

  

Address (To)

 mailSettings address String

Maximum 256 ASCII characters

You can enter email addresses that are based on the RFC and are divided by a comma (,).

Use one of the following formats for the email addresses:

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

 If the "enableNotification" for the "mailSettings" is "true" and an address (To) has never been registered, you cannot omit this parameter.

Address (Cc)

 cc String

Maximum 256 ASCII characters

You can enter email addresses that are based on the RFC and are divided by a comma (,).

Use one of the following formats for the email addresses:

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

  

To send an email (ON/OFF)

 enableNotification Boolean

•　true: On

•　false: Off

  
Subject prefix subjectPrefix String

You can add the letters to the beginning of the subject for all notification emails.

Maximum 20 characters

  

Receive log error notification (ON/OFF)

 receiveLogErrorSettings enableNotification Boolean

•　true: On

•　false: Off

  

Term License Key expiration notification (ON/OFF)

 termKeyExpirationSettings enableNotification Boolean

•　true: On

•　false: Off

  

Term License Key expiration notification threshold

 beforeDays String

Specify when the notification email will be sent by using the number of days before the term of license is expired.

1 to 30 (days)

  

Trace log error notification (ON/OFF)

 traceLogErrorSettings enableNotification Boolean

•　true: On

•　false: Off

  

Transfer log error notification (ON/OFF)

 transferLogErrorSettings enableNotification Boolean

•　true: On

•　false: Off

  
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

For details of the response parameters, see Response parameter described in Acquire system settings (notifications).