IBM Cloud API Docs

Introduction

Last updated: 2019-03-19

API for creating, retrieving, editing, and listing event policies.

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

getAttributes

List the supported attributes and operations on this server.

GET /eventPoliciesSpecification/v2/eventAttributes

Request

Custom Headers

  • Accept
    string

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

Response

Response Body

supportedAttribute[]

Status Code

  • 200

    Successful request

  • 400

    Invalid request

  • 401

    Unauthorized

  • 403

    Not authorized

No Sample Response

This method does not specify any sample responses.

getEventPolicies

List the summary information for all event policies within a subscription

GET /eventPolicies/v2

Request

Custom Headers

  • Accept
    string

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

Response

Response Body

eventPolicyHeader[]

Status Code

  • 200

    Successful request

  • 400

    Invalid request

  • 401

    Unauthorized

  • 403

    Not authorized

Example responses
  • [
  {
    "id": "123-abc",
    "name": "SamplePolicy",
    "description": "Sample policy description",
    "enabled": true,
    "actions": {
      "suppress": {
        "enabled": true,
        "suppressCondition": "XinY",
        "identicalEvents": 1,
        "timePeriod": 120,
        "timeUnits": "seconds"
      },
      "enrich": {
        "enabled": false
      },
      "runbook": {
        "enabled": false
      }
    },
    "author": "user@example.com",
    "created": "2017-03-10T10:02:47.297Z",
    "lastUpdated": "2017-03-10T10:03:24.672Z",
    "lastUpdatedBy": "user@example.com",
    "lastRun": 0
  }
]

createEventPolicy

Creates an event policy within a subscription

POST /eventPolicies/v2

Request

Custom Headers

  • Accept
    string

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

Request Body

Required*
eventPolicy

Event policy payload

Response

Response Body

eventPolicy

Status Code

  • 201

    Policy successfully created

  • 400

    Invalid request

  • 401

    Unauthorized

  • 403

    Not authorized

  • 409

    Already exists

No Sample Response

This method does not specify any sample responses.

updateEventPolicy

Replace the policy with the policy payload provided. Note the conditions array is replaced by the received conditions array. Conditions are not merged.

PUT /eventPolicies/v2/{id}

Request

Custom Headers

  • Accept
    string

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

Path Parameters

  • id
    Required*
    string

    Policy reference ID. This is returned by the list policies GET and uniquely identifies the policy.

Request Body

Required*
eventPolicy

Event policy payload

Response

Response Body

eventPolicy

Status Code

  • 200

    Successful request

  • 400

    Policy was not updated

  • 401

    Unauthorized

  • 403

    Not authorized

  • 404

    Unable to locate policy

  • 409

    Cannot rename to the name of a policy that already exists

No Sample Response

This method does not specify any sample responses.

getEventPolicy

Gets a policy

GET /eventPolicies/v2/{id}

Request

Custom Headers

  • Accept
    string

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

Path Parameters

  • id
    Required*
    string

    Policy reference ID. This is returned by the list policies GET and uniquely identifies the policy.

Response

Response Body

eventPolicy

Status Code

  • 200

    Successful request

  • 401

    Unauthorized

  • 403

    Not authorized

  • 404

    Unable to locate policy

No Sample Response

This method does not specify any sample responses.

deleteEventPolicy

Deletes a policy

DELETE /eventPolicies/v2/{id}

Request

Custom Headers

  • Accept
    string

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

Path Parameters

  • id
    Required*
    string

    Policy reference ID. This is returned by the list policies GET and uniquely identifies the policy.

Response

Status Code

  • 204

    Successful request

  • 401

    Unauthorized

  • 403

    Not authorized

  • 404

    Unable to locate policy

  • 500

    Error deleting policy

No Sample Response

This method does not specify any sample responses.

changePoliciesExecOrder

Sets the new order on a list of policies in a subscription.

PUT /eventPolicies/v2/executionOrder

Request

Custom Headers

  • Accept
    string

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

Request Body

Required*
string[]

Array of policy IDs in the order they should be run.

Response

Status Code

  • 204

    Successful request

  • 401

    Unauthorized

  • 403

    Not authorized

  • 500

    Error updating policy

No Sample Response

This method does not specify any sample responses.