Introduction

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

Error handling

This API uses the 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

updateConditionsCache

Updates the incident policy cache and returns the flat policies stored in the cache.

GET /incidentPoliciesCache/v1
Request

Custom Headers

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

Response

Flat policies stored within the cache

Status Code

  • Successful request

  • Invalid request

  • Unauthorized

  • Not authorized

No Sample Response

This method does not specify any sample responses.

listConditionAttributes

List the supported conditions attributes and operations.

GET /spec/incidentPolicies/v1/conditionAttributes
Request

Custom Headers

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

Response

Status Code

  • Successful request

  • Invalid request

  • Unauthorized

  • Not authorized

No Sample Response

This method does not specify any sample responses.

listPolicies

List the summary information for all policies within a subscription

GET /incidentPolicies/v1
Request

Custom Headers

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

Query Parameters

  • Includes detail information with each policy

    Constraints: allows empty value

    Default: false

Response

Status Code

  • Successful request

  • Invalid request

  • Unauthorized

  • Not authorized

Example responses

createPolicy

Creates an incident policy within a subscription

POST /incidentPolicies/v1
Request

Custom Headers

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

Incident policy payload

Response

Status Code

  • Policy successfully created

  • Invalid request

  • Unauthorized

  • Not authorized

  • Already exists

  • Internal error

No Sample Response

This method does not specify any sample responses.

updatePolicy

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

PUT /incidentPolicies/v1/{id}
Request

Custom Headers

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

Path Parameters

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

Incident policy payload

Response

Status Code

  • Successful request

  • Policy was not updated

  • Unauthorized

  • Not authorized

  • Unable to locate policy

  • Cannot rename to the name of a policy that already exists

  • Internal error

No Sample Response

This method does not specify any sample responses.

getPolicy

Gets a policy

GET /incidentPolicies/v1/{id}
Request

Custom Headers

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

Path Parameters

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

Response

Status Code

  • Successful request

  • Unauthorized

  • Not authorized

  • Unable to locate policy

  • Internal error

Example responses

deletePolicyById

Deletes a policy

DELETE /incidentPolicies/v1/{id}
Request

Custom Headers

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

Path Parameters

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

Response

Status Code

  • Successful request

  • Unauthorized

  • Not authorized

  • Unable to locate policy

  • Internal error

No Sample Response

This method does not specify any sample responses.

UpdatePolicyOrder

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

PUT /incidentPolicies/v1/executionOrder
Request

Custom Headers

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

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

Response

Status Code

  • Successful request

  • Bad request

  • Unauthorized

  • Not authorized

  • Internal error updating execution order of policies

No Sample Response

This method does not specify any sample responses.

bulkDeletePolicies

Deletes a list of policies in a subscription

POST /incidentPolicyBulk/v1/bulkdelete
Request

Custom Headers

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

Array of policy IDs to delete

Response

Status Code

  • Successful request

  • Unauthorized

  • Not authorized

  • Internal error

No Sample Response

This method does not specify any sample responses.

bulkUpdatePolicyOrder

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

PUT /incidentPolicyBulk/v1/bulkupdateorder
Request

Custom Headers

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

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

Response

Status Code

  • Successful request

  • Bad request

  • Unauthorized

  • Not authorized

  • Internal error updating execution order of policies

No Sample Response

This method does not specify any sample responses.