{ "opencollection": "1.0.0", "info": { "name": "PagerDuty Abilities Incident Workflows API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Incident Workflows", "type": "folder" }, "items": [ { "info": { "name": "PagerDuty List Incident Workflows", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows", "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": "include[]", "value": "", "type": "query", "description": "Array of additional details to include." } ] }, "docs": "List existing Incident Workflows.\n\nThis is the best method to use to list all Incident Workflows in your account. If your use case requires listing Incident Workflows associated with a particular Service, you can use the \"List Triggers\" method to find Incident Workflows configured to start for Incidents in a given Service.\n\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_wo" }, { "info": { "name": "PagerDuty Create an Incident Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/incident_workflows", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Incident Workflow\n\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Get an Incident Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Get an existing Incident Workflow\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_workflows.read`\n" }, { "info": { "name": "PagerDuty Update an Incident Workflow", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/incident_workflows/: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 Incident Workflow\n\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Delete an Incident Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/incident_workflows/: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 Incident Workflow\n\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Start an Incident Workflow Instance", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/incident_workflows/:id/instances", "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": "Start an Instance of an Incident Workflow. Sometimes referred to as \"triggering a workflow on an incident.\"\n\nAn Incident Workflow is a sequence of configurable Steps and associated Triggers that can execute automated Actions for a given Incident.\n\nScoped OAuth requires: `incident_workflows:instances.write`\n" }, { "info": { "name": "PagerDuty List Actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows/actions", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "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": "keyword", "value": "", "type": "query", "description": "If provided, only show actions tagged with the specified keyword" } ] }, "docs": "List Incident Workflow Actions\n\nScoped OAuth requires: `incident_workflows.read`\n" }, { "info": { "name": "PagerDuty Get an Action", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows/actions/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Get an Incident Workflow Action\n\nScoped OAuth requires: `incident_workflows.read`\n" }, { "info": { "name": "PagerDuty List Triggers", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows/triggers", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "workflow_id", "value": "", "type": "query", "description": "If provided, only show triggers configured to start the given workflow. Useful for listing all services associated with the given workflow" }, { "name": "incident_id", "value": "", "type": "query", "description": "If provided, only show triggers configured on the service of the given incident. Useful for finding manual triggers that are configured on the service for a specific incident. Cannot be specified if `service_id` is provided." }, { "name": "service_id", "value": "", "type": "query", "description": "If provided, only show triggers configured for incidents in the given service. Useful for listing all workflows associated with the given service. Cannot be specified if `incident_id` is provided." }, { "name": "trigger_type", "value": "", "type": "query", "description": "If provided, only show triggers of the given type. For example “manual” to search for manual triggers" }, { "name": "workflow_name_contains", "value": "", "type": "query", "description": "If provided, only show triggers configured to start workflows whose name contain the provided value." }, { "name": "sort_by", "value": "", "type": "query", "description": "If provided, returns triggers sorted by the specified property." }, { "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" } ] }, "docs": "List existing Incident Workflow Triggers\n\nScoped OAuth requires: `incident_workflows.read`\n" }, { "info": { "name": "PagerDuty Create a Trigger", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/incident_workflows/triggers", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new Incident Workflow Trigger\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Get a Trigger", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/incident_workflows/triggers/:id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the resource." } ] }, "docs": "Retrieve an existing Incident Workflows Trigger\n\nScoped OAuth requires: `incident_workflows.read`\n" }, { "info": { "name": "PagerDuty Update a Trigger", "type": "http" }, "http": { "method": "PUT", "url": "https://api.pagerduty.com/incident_workflows/triggers/: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 Incident Workflow Trigger\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Delete a Trigger", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/incident_workflows/triggers/: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 Incident Workflow Trigger\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Associate a Trigger and Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.pagerduty.com/incident_workflows/triggers/:id/services", "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": "Associate a Service with an existing Incident Workflow Trigger\n\nScoped OAuth requires: `incident_workflows.write`\n" }, { "info": { "name": "PagerDuty Dissociate a Trigger and Service", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pagerduty.com/incident_workflows/triggers/:trigger_id/services/:service_id", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "trigger_id", "value": "", "type": "path", "description": "Identifier for the Trigger" }, { "name": "service_id", "value": "", "type": "path", "description": "Identifier for the Service" } ] }, "docs": "Remove a an existing Service from an Incident Workflow Trigger\n\nScoped OAuth requires: `incident_workflows.write`\n" } ] } ], "bundled": true }