Squadcast is now SolarWinds Incident Response
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Escalation Policies

Get Escalation Policy By team

get
/v3/escalation-policies

Returns all escalation policy details of the given ownerID (teamId) in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
owner_idstringRequired

here owner_id represents team_id, if team_id is not provided, it will return escalation policies of all teams.

page_numberintegerOptional
page_sizeintegerOptional
Header parameters
authorizationstringRequired
Responses
200

The request has succeeded.

application/json
get/v3/escalation-policies
GET /v3/escalation-policies?owner_id=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "organization_id": "text",
      "repetition": 1,
      "repeat_after": 1,
      "rules": [
        {
          "escalationTime": 1,
          "via": [
            "text"
          ],
          "roundrobin_enabled": true,
          "roundrobin_next_index": 1,
          "entities": [
            {
              "id": "text",
              "pid": 1,
              "type": "user"
            }
          ],
          "escalate_within_roundrobin": true,
          "repetition": 1,
          "repeat_after": 1
        }
      ],
      "slug": "text",
      "enable_incident_reminders": true,
      "incident_reminder_rules": [
        {
          "via": [
            "text"
          ],
          "time_interval": 1,
          "till": 1
        }
      ],
      "enable_incident_retrigger": true,
      "retrigger_after": 1,
      "entity_owner": {
        "id": "text",
        "type": "text"
      },
      "owner": {
        "id": "text",
        "type": "team"
      },
      "access_control": [
        {
          "user_id": "text",
          "abilities": {}
        }
      ]
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Create Escalation Policies

post
/v3/escalation-policies

Add escalation policy to the organization. Returns the escalation policy object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
owner_idstringRequired

The ID of the team that owns this escalation policy.

namestringRequired

The name of the escalation policy.

descriptionstringRequired

A description of the escalation policy.

repetitioninteger · int32Required

The number of times the entire policy should be repeated.

repeat_afterinteger · int32Required

The time in minutes after which the policy should be repeated.

enable_incident_remindersbooleanRequired

Enable or disable incident reminders.

enable_incident_retriggerbooleanRequired

Enable or disable automatic incident re-triggering.

retrigger_afterinteger · int32Required

The time in hours after which an incident should be re-triggered.

Responses
201

The request has succeeded and a new resource has been created as a result.

application/json
post/v3/escalation-policies
POST /v3/escalation-policies HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 500

{
  "owner_id": "text",
  "name": "text",
  "description": "text",
  "repetition": 1,
  "repeat_after": 1,
  "rules": [
    {
      "escalationTime": 1,
      "via": [
        "text"
      ],
      "roundrobin_enabled": true,
      "roundrobin_next_index": 1,
      "entities": [
        {
          "id": "text",
          "pid": 1,
          "type": "user"
        }
      ],
      "escalate_within_roundrobin": true,
      "repetition": 1,
      "repeat_after": 1
    }
  ],
  "enable_incident_reminders": true,
  "incident_reminder_rules": [
    {
      "via": [
        "text"
      ],
      "time_interval": 1,
      "till": 1
    }
  ],
  "enable_incident_retrigger": true,
  "retrigger_after": 1,
  "entity_owner": {
    "id": "text",
    "type": "text"
  }
}
{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Get Escalation Policy By ID

get
/v3/escalation-policies/{escalationPolicyID}

Returns an escalation policy details of the given escalationPolicyID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
escalationPolicyIDstringRequired

(Required) escalation policy ID

Responses
200

The request has succeeded.

application/json
get/v3/escalation-policies/{escalationPolicyID}
GET /v3/escalation-policies/{escalationPolicyID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Update Escalation Policy

post
/v3/escalation-policies/{escalationPolicyID}

Update organization escalation policy details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
escalationPolicyIDstringRequired

(Required) escalation policy ID

Header parameters
authorizationstringRequired
Body
owner_idstringOptional

The ID of the team that owns this escalation policy.

namestringOptional

The name of the escalation policy.

descriptionstringOptional

A description of the escalation policy.

repetitioninteger · int32Optional

The number of times the entire policy should be repeated.

repeat_afterinteger · int32Optional

The time in minutes after which the policy should be repeated.

enable_incident_remindersbooleanOptional

Enable or disable incident reminders.

enable_incident_retriggerbooleanOptional

Enable or disable automatic incident re-triggering.

retrigger_afterinteger · int32Optional

The time in hours after which an incident should be re-triggered.

Responses
200

The request has succeeded.

application/json
post/v3/escalation-policies/{escalationPolicyID}
POST /v3/escalation-policies/{escalationPolicyID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: text/plain
Accept: */*
Content-Length: 500

"[object Object]"
{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "organization_id": "text",
    "repetition": 1,
    "repeat_after": 1,
    "rules": [
      {
        "escalationTime": 1,
        "via": [
          "text"
        ],
        "roundrobin_enabled": true,
        "roundrobin_next_index": 1,
        "entities": [
          {
            "id": "text",
            "pid": 1,
            "type": "user"
          }
        ],
        "escalate_within_roundrobin": true,
        "repetition": 1,
        "repeat_after": 1
      }
    ],
    "slug": "text",
    "enable_incident_reminders": true,
    "incident_reminder_rules": [
      {
        "via": [
          "text"
        ],
        "time_interval": 1,
        "till": 1
      }
    ],
    "enable_incident_retrigger": true,
    "retrigger_after": 1,
    "entity_owner": {
      "id": "text",
      "type": "text"
    },
    "owner": {
      "id": "text",
      "type": "team"
    },
    "access_control": [
      {
        "user_id": "text",
        "abilities": {}
      }
    ]
  }
}

Remove Escalation Policy

delete
/v3/escalation-policies/{escalationPolicyID}

Remove escalation policy from the organization. Upon success, the escalation policy will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
escalationPolicyIDstringRequired

(Required) escalation policy ID

Header parameters
authorizationstringRequired
Responses
204

There is no content to send for this request, but the headers may be useful.

*/*
objectOptional
delete/v3/escalation-policies/{escalationPolicyID}
DELETE /v3/escalation-policies/{escalationPolicyID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*
{}

Last updated