Alert Group Settings

List of alert group settings

GET /api/v0/alert-group-settings

Required permissions for API key

  • Read

Response

Success

{
  "alert_group_settings": [<alertGroupSetting>, <alertGroupSetting>, ...]
}

<alertGroupSetting>: an object that holds the following keys.

KEY TYPE DESCRIPTION
id string the alert group setting ID
name string the name of alert group setting
memo string [optional] notes related to the alert group setting
serviceScopes array[string] [optional] scope for the target service. an array of the service name
roleScopes array[string] [optional] scope for the target role. an array of the role fullname *1
monitorScopes array[string] [optional] scope for the target monitor. an array of the monitor ID
notificationInterval number [optional] the time interval (in minutes) for re-sending notifications

*1 role fullname

A role's full name is an array in the format of <service name>:<role name>.

e.g. if a Hatena-Bookmark service db-master role Hatena-Bookmark:db-master

available strings are /^[A-Za-z0-9][A-Za-z0-9_-]+$/

Create alert group settings

POST /api/v0/alert-group-settings

Required permissions for API key

  • Read
  • Write

Input

KEY TYPE DESCRIPTION
name string the name of alert group setting
memo string [optional] notes related to the alert group setting
serviceScopes array[string] [optional] scope for the target service. an array of the service name
roleScopes array[string] [optional] scope for the target role. an array of the role's fullname *1
monitorScopes array[string] [optional] scope for the target monitor. an array of the monitor ID
notificationInterval number [optional] the time interval (in minutes) for re-sending notifications

Response

Success

Information for the created alert group setting is returned. The format is the same as that which can be obtained with List of alert group settings.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be received
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range

Get alert group settings

GET /api/v0/alert-group-settings/<alertGroupSettingId>

Required permissions for API key

  • Read

Response

Success

Information for the alert group setting is returned. The format is the same as that which can be obtained with List of alert group settings.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be received
404 when the specified alert group setting does not exist
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range

Update alert group settings

PUT /api/v0/alert-group-settings/<alertGroupSettingId>

Required permissions for API key

  • Read
  • Write

Input

The same format as Create alert group settings.

Response

Success

Information for the updated alert group setting is returned. The format is the same as that which can be obtained with List of alert group settings.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be received
404 when the specified alert group setting does not exist
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range

Delete alert group settings

DELETE /api/v0/alert-group-settings/<alertGroupSettingId>

Required permissions for API key

  • Read
  • Write

Response

Success

Information for the deleted alert group setting is returned. The format is the same as that which can be obtained with List of alert group settings.

Error

STATUS CODE DESCRIPTION
400 when the input is in a format that can’t be received
404 when the specified alert group setting does not exist
403 when the API doesn't have the required permissions / when accessing from outside the permitted IP address range