{ "opencollection": "1.0.0", "info": { "name": "PagerDuty Abilities Services API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Services", "type": "folder" }, "items": [ { "info": { "name": "PagerDuty List services", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "query", "value": "", "type": "query", "description": "Filters the result, showing only the records whose name matches the query." }, { "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": "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": "time_zone", "value": "", "type": "query", "description": "Time zone in which results will be rendered. This will default to the account time zone." }, { "name": "sort_by", "value": "", "type": "query", "description": "Used to specify the field you wish to sort the results on." }, { "name": "include[]", "value": "", "type": "query", "description": "Array of additional details to include." }, { "name": "name", "value": "", "type": "query", "description": "Filters the results, showing only services with the specified name." } ] }, "docs": "List existing Services.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.read`\n" }, { "info": { "name": "PagerDuty Create a service", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/services", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new service.\n\nIf `status` is included in the request, it must have a value of `active` when creating a new service. If a different status is required, make a second request to update the service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nThere is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and" }, { "info": { "name": "PagerDuty Get a service", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services/: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 details to include." } ] }, "docs": "Get details about an existing service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.read`\n" }, { "info": { "name": "PagerDuty Update a service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/services/: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": "Update an existing service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nThere is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable `auto_resolve_timeout` (set to 0 or null), the API will respond with an error.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.write`\n" }, { "info": { "name": "PagerDuty Delete a service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/services/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Delete an existing service.\n\nOnce the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.write`\n" }, { "info": { "name": "PagerDuty List audit records for a service", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services/: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" }, { "info": { "name": "PagerDuty Create a new integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/services/:id/integrations", "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": "Create a new integration belonging to a Service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.write`\n" }, { "info": { "name": "PagerDuty View an integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services/:id/integrations/:integration_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "integration_id", "value": "", "type": "path", "description": "The integration ID on the service." }, { "name": "include[]", "value": "", "type": "query", "description": "Array of additional details to include." } ] }, "docs": "Get details about an integration belonging to a service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.read`\n" }, { "info": { "name": "PagerDuty Update an existing integration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/services/:id/integrations/:integration_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "integration_id", "value": "", "type": "path", "description": "The integration ID on the service." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an integration belonging to a Service.\n\nA service may represent an application, component, or team you wish to open incidents against.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#services)\n\nScoped OAuth requires: `services.write`\n" }, { "info": { "name": "PagerDuty List Service's Event Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services/:id/rules", "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": "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": "List Event Rules on a Service.\n\n> ### End-of-life\n> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.\n\nScoped OAuth requires: `services.read`\n" }, { "info": { "name": "PagerDuty Create an Event Rule on a Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/services/:id/rules", "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": "Create a new Event Rule on a Service.\n\n> ### End-of-life\n> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.\n\nScoped OAuth requires: `services.write`\n" }, { "info": { "name": "PagerDuty Convert a Service's Event Rules into Event Orchestration Rules", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/services/:id/rules/convert", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Convert this Service's Event Rules into functionally equivalent Event Orchestration Rules.\n\nSending a request to this API endpoint has several effects:\n\n1. Automatically creates Event Orchestration Rules for this Service that will behave identically as this Service's currently configured Event Rules.\n2. Makes all existing Event Rules for this Service read-only. All future updates need to be made via the newly created Event Orchestration rules.\n\nSending a request to this API endpoint will **not**" }, { "info": { "name": "PagerDuty Get an Event Rule from a Service", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/services/:id/rules/:rule_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "rule_id", "value": "", "type": "path", "description": "The id of the Event Rule to retrieve." } ] }, "docs": "Get an Event Rule from a Service.\n\n> ### End-of-life\n> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.\n\nScoped OAuth requires: `services.read`\n" }, { "info": { "name": "PagerDuty Update an Event Rule on a Service", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/services/:id/rules/:rule_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "rule_id", "value": "", "type": "path", "description": "The id of the Event Rule to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Event Rule on a Service. Note that the endpoint supports partial updates, so any number of the writable fields can be provided.\n\n> ### End-of-life\n> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advan" }, { "info": { "name": "PagerDuty Delete an Event Rule from a Service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/services/:id/rules/:rule_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." }, { "name": "rule_id", "value": "", "type": "path", "description": "The id of the Event Rule to retrieve." } ] }, "docs": "Delete an Event Rule from a Service.\n\n> ### End-of-life\n> Rulesets and Event Rules will end-of-life soon. We highly recommend that you [migrate to Event Orchestration](https://support.pagerduty.com/docs/migrate-to-event-orchestration) as soon as possible so you can take advantage of the new functionality, such as improved UI, rule creation, APIs and Terraform support, advanced conditions, and rule nesting.\n\nScoped OAuth requires: `services.write`\n" } ] } ], "bundled": true }