IBM Cloud API Docs

Introduction

Last updated: 2018-06-12

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

  • Accept
    string

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

Response

Response Body

Group[]

Status Code

  • 200

    Successful request

  • 401

    Authorization failed

  • 403

    Forbidden

  • 500

    Internal system error

No Sample Response

This method does not specify any sample responses.

addGroup

Adds a group

POST /groups/v1

Request

Custom Headers

  • Accept
    string

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

Request Body

Required*
Group

Group object.

Response

Response Body

Group

Status Code

  • 201

    Group successfully created

  • 400

    Invalid request

  • 401

    Authorization failed

  • 403

    Forbidden

  • 409

    Group already exists

  • 415

    Invalid media type

  • 500

    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

  • Accept
    string

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

Path Parameters

  • name
    Required*
    string

    unique name of the group to delete

Response

Status Code

  • 204

    Successful request

  • 400

    Cannot delete group

  • 401

    Authorization failed

  • 403

    Forbidden

  • 404

    Unable to locate group

  • 500

    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

  • Accept
    string

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

Path Parameters

  • name
    Required*
    string

    unique name of the group to get

Response

Response Body

Group

Status Code

  • 200

    Successful request

  • 401

    Authorization failed

  • 403

    Forbidden

  • 404

    Unable to locate group

  • 500

    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

  • Accept
    string

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

Path Parameters

  • name
    Required*
    string

    unique name of the group to modify

Request Body

Required*
GroupModification

Group object

Response

Response Body

Group

Status Code

  • 200

    Successful request

  • 400

    Invalid request

  • 401

    Authorization failed

  • 403

    Forbidden

  • 404

    Unable to locate group

  • 415

    Invalid media type

  • 500

    Internal system error

No Sample Response

This method does not specify any sample responses.