Introduction

The groups that will receive notifications for the alerts can be managed with this API.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

listGroups

Lists all groups

GET /groups/v1
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Response

Status Code

  • Successful request

  • Authorization failed

  • Forbidden

  • Internal system error

No Sample Response

This method does not specify any sample responses.

addGroup

Adds a group

POST /groups/v1
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Group object.

Response

Status Code

  • Group successfully created

  • Invalid request

  • Authorization failed

  • Forbidden

  • Group already exists

  • Invalid media type

  • Internal system error

No Sample Response

This method does not specify any sample responses.

deleteGroup

Deletes a group

DELETE /groups/v1/{name}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • unique name of the group to delete

Response

Status Code

  • Successful request

  • Cannot delete group

  • Authorization failed

  • Forbidden

  • Unable to locate group

  • Internal system error

No Sample Response

This method does not specify any sample responses.

getGroup

Gets a group

GET /groups/v1/{name}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • unique name of the group to get

Response

Status Code

  • Successful request

  • Authorization failed

  • Forbidden

  • Unable to locate group

  • Internal system error

No Sample Response

This method does not specify any sample responses.

modifyGroup

Modifies the properties of a group

PUT /groups/v1/{name}
Request

Custom Headers

  • Allowable values: [application/json,text/plain]

Path Parameters

  • unique name of the group to modify

Group object

Response

Status Code

  • Successful request

  • Invalid request

  • Authorization failed

  • Forbidden

  • Unable to locate group

  • Invalid media type

  • Internal system error

No Sample Response

This method does not specify any sample responses.