{ "opencollection": "1.0.0", "info": { "name": "PagerDuty Abilities Escalation Policies API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Escalation Policies", "type": "folder" }, "items": [ { "info": { "name": "PagerDuty List escalation policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/escalation_policies", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The number of results per page." }, { "name": "offset", "value": "", "type": "query", "description": "Offset to start pagination search results." }, { "name": "total", "value": "", "type": "query", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n" }, { "name": "query", "value": "", "type": "query", "description": "Filters the result, showing only the records whose name matches the query." }, { "name": "user_ids[]", "value": "", "type": "query", "description": "Filters the results, showing only escalation policies on which any of the users is a target." }, { "name": "team_ids[]", "value": "", "type": "query", "description": "An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter." }, { "name": "include[]", "value": "", "type": "query", "description": "Array of additional Models to include in response." }, { "name": "sort_by", "value": "", "type": "query", "description": "Used to specify the field you wish to sort the results on." } ] }, "docs": "List all of the existing escalation policies.\n\nEscalation policies define which user should be alerted at which time.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)\n\nScoped OAuth requires: `escalation_policies.read`\n" }, { "info": { "name": "PagerDuty Create an escalation policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/escalation_policies", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" }, { "name": "From", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new escalation policy. At least one escalation rule must be provided.\n\nEscalation policies define which user should be alerted at which time.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)\n\nScoped OAuth requires: `escalation_policies.write`\n" }, { "info": { "name": "PagerDuty Get an escalation policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/escalation_policies/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "include[]", "value": "", "type": "query", "description": "Array of additional Models to include in response." } ] }, "docs": "Get information about an existing escalation policy and its rules.\n\nEscalation policies define which user should be alerted at which time.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)\n\nScoped OAuth requires: `escalation_policies.read`\n" }, { "info": { "name": "PagerDuty Update an escalation policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/escalation_policies/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing escalation policy and rules.\n\nEscalation policies define which user should be alerted at which time.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)\n\nScoped OAuth requires: `escalation_policies.write`\n" }, { "info": { "name": "PagerDuty Delete an escalation policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/escalation_policies/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services.\n\nEscalation policies define which user should be alerted at which time.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#escalation-policies)\n\nScoped OAuth requires: `escalation_policies.write`\n" }, { "info": { "name": "PagerDuty List audit records for an escalation policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/escalation_policies/:id/audit/records", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "limit", "value": "", "type": "query", "description": "The minimum of the `limit` parameter used in the request or the maximum request size of the API." }, { "name": "cursor", "value": "", "type": "query", "description": "Optional parameter used to request the \"next\" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set.\n" }, { "name": "since", "value": "", "type": "query", "description": "The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours)" }, { "name": "until", "value": "", "type": "query", "description": "The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`." } ] }, "docs": "The returned records are sorted by the `execution_time` from newest to oldest.\n\nSee [`Cursor-based pagination`](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for instructions on how to paginate through the result set.\n\nFor more information see the [Audit API Document](https://developer.pagerduty.com/docs/rest-api-v2/audit-records-api/).\n\nScoped OAuth requires: `audit_records.read`\n" } ] } ], "bundled": true }