Alert Group Settings

Listing Alert Group Settings

GET /api/v0/alert-group-settings

Required permissions for the 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 service names
roleScopes array[string] [optional] scope for the target role. an array of role fullnames *1
monitorScopes array[string] [optional] scope for the target monitor. an array of monitor IDs
notificationInterval number [optional] the time interval (in minutes) for resending notifications

*1 role fullname

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

e.g. if you have Hatena-Bookmark as the service and db-master as the role, its role fullname is Hatena-Bookmark:db-master

available strings for the role fullname must match the following regular expression: /^[A-Za-z0-9][A-Za-z0-9_-]+$/

Creating Alert Group Settings

POST /api/v0/alert-group-settings

Required permissions for the API key

  • Read
  • Write

Input

KEY TYPE DESCRIPTION
name string the name of the 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 service names
roleScopes array[string] [optional] scope for the target role. an array of the role's fullnames *1
monitorScopes array[string] [optional] scope for the target monitor. an array of monitor IDs
notificationInterval number [optional] the time interval (in minutes) for resending notifications

Response

Success

The created alert group setting is returned. The response format is the same as that which can be obtained with Listing Alert Group Settings.

Error

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

Getting Alert Group Settings

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

Required permissions for the API key

  • Read

Response

Success

The alert group setting is returned. The response format is the same as that which can be obtained with Listing 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 key doesn't have the required permissions / when accessing from outside the permitted IP address range

Updating Alert Group Settings

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

Required permissions for the API key

  • Read
  • Write

Input

The same format as Creating Alert Group Settings.

Response

Success

The updated alert group setting is returned. The response format is the same as that which can be obtained with Listing 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 key doesn't have the required permissions / when accessing from outside the permitted IP address range

Deleting Alert Group Settings

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

Required permissions for the API key

  • Read
  • Write

Response

Success

The deleted alert group setting is returned. The response format is the same as that which can be obtained with Listing 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 key doesn't have the required permissions / when accessing from outside the permitted IP address range