openapi: 3.0.2 info: description: 'This document describes the PagerDuty REST APIs. For guides and examples please visit our [Documentation.](https://developer.pagerduty.com/docs/get-started/getting-started/) Our REST APIs are defined in OpenAPI v3.x. You can view the schema at [github.com/PagerDuty/api-schema](https://github.com/PagerDuty/api-schema). Note that properties in some schemas have fields not shown by default such as `readOnly`, `format`, and `default`. Hover your cursor over the right column that looks like `optional+1` to see the full list of fields. ' contact: name: PagerDuty Support url: http://www.pagerduty.com/support email: support@pagerduty.com title: PagerDuty Abilities Incidents API version: 2.0.0 servers: - url: https://api.pagerduty.com description: PagerDuty V2 API. security: - api_key: [] tags: - name: Incidents description: 'An incident represents a problem or an issue that needs to be addressed and resolved. Incidents trigger on a service, which prompts notifications to go out to on-call responders per the service''s escalation policy. ' paths: /incidents: description: List and update incidents. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: listIncidents description: 'List existing incidents. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty List incidents parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/incident_list_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/offset_total' - $ref: '#/components/parameters/date_range' - $ref: '#/components/parameters/incident_key' - $ref: '#/components/parameters/incident_services' - $ref: '#/components/parameters/team_ids' - $ref: '#/components/parameters/incident_assigned_to_user' - $ref: '#/components/parameters/incident_urgencies' - $ref: '#/components/parameters/time_zone' - $ref: '#/components/parameters/statuses_incidents' - $ref: '#/components/parameters/sort_by_incidents' - $ref: '#/components/parameters/include_incidents' - $ref: '#/components/parameters/since_incidents' - $ref: '#/components/parameters/until_incidents' responses: '200': description: A paginated array of incidents. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: incidents: type: array items: $ref: '#/components/schemas/Incident' required: - incidents examples: response: summary: Response Example value: incidents: - id: PT4KHLK type: incident summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 title: The server is on fire. created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: resolved incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 assignments: [] assigned_via: escalation_policy last_status_change_at: '2015-10-06T21:38:23Z' resolved_at: '2015-10-06T21:38:23Z' first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV alert_counts: all: 2 triggered: 0 resolved: 2 is_mergeable: true escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 pending_actions: [] acknowledgements: [] alert_grouping: grouping_type: advanced started_at: '2015-10-06T21:30:42Z' ended_at: null alert_grouping_active: true last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 priority: id: P53ZZH5 type: priority_reference summary: P2 self: https://api.pagerduty.com/priorities/P53ZZH5 resolve_reason: null conference_bridge: conference_number: +1-415-555-1212,,,,1234# conference_url: https://example.com/acb-123 incidents_responders: [] responder_requests: [] urgency: high limit: 1 offset: 0 more: true '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' put: x-pd-requires-scope: incidents.write x-pd-operation-limit: true tags: - Incidents operationId: updateIncidents description: 'Acknowledge, resolve, escalate or reassign one or more incidents. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 250 incidents may be updated at a time. If more than this number of incidents are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information. ' summary: PagerDuty Manage incidents parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/offset_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/offset_total' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: incidents: type: array description: An array of incidents, including the parameters to update. items: properties: id: type: string description: The id of the incident to update. type: type: string description: The incident type. enum: - incident - incident_reference status: type: string description: The new status of the incident. enum: - resolved - acknowledged resolution: type: string description: The resolution for this incident if status is set to resolved. title: type: string description: A succinct description of the nature, symptoms, cause, or effect of the incident. priority: $ref: '#/components/schemas/PriorityReference' escalation_level: type: integer description: Escalate the incident to this level in the escalation policy. assignments: type: array description: Assign the incident to these assignees. items: properties: assignee: $ref: '#/components/schemas/UserReference' escalation_policy: $ref: '#/components/schemas/EscalationPolicyReference' conference_bridge: $ref: '#/components/schemas/ConferenceBridge' required: - id - type required: - incidents examples: incidents: summary: Request Example value: incidents: - id: PT4KHLK type: incident_reference status: acknowledged - id: PQMF62U type: incident_reference priority: id: P53ZZH5 type: priority_reference - id: PPVZH9X type: incident_reference status: resolved - id: P8JOGX7 type: incident_reference assignments: - assignee: id: PXPGF42 type: user_reference responses: '200': description: All of the updates succeeded. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: incidents: type: array items: $ref: '#/components/schemas/Incident' required: - incidents examples: response: summary: Response Example value: incidents: - id: PT4KHLK type: incident summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: resolved title: The server is on fire. alert_counts: all: 2 triggered: 0 resolved: 2 pending_actions: - type: unacknowledge at: '2015-11-10T01:02:52Z' - type: resolve at: '2015-11-10T04:31:52Z' incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 assigned_via: escalation_policy assignments: - at: '2015-11-10T00:31:52Z' assignee: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 acknowledgements: - at: '2015-11-10T00:32:52Z' acknowledger: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 resolved_at: '2015-10-06T21:38:23Z' last_status_change_at: '2015-10-06T21:38:23Z' last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 urgency: high '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '413': $ref: '#/components/responses/RequestEntityTooLarge' '429': $ref: '#/components/responses/TooManyRequests' post: x-pd-requires-scope: incidents.write x-pd-operation-limit: true tags: - Incidents operationId: createIncident description: 'Create an incident synchronously without a corresponding event from a monitoring service. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` This API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for more information. ' summary: PagerDuty Create an Incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: incident: type: object description: Details of the incident to be created. properties: type: type: string enum: - incident title: type: string description: A succinct description of the nature, symptoms, cause, or effect of the incident. service: $ref: '#/components/schemas/ServiceReference' priority: $ref: '#/components/schemas/PriorityReference' urgency: type: string description: The urgency of the incident enum: - high - low body: $ref: '#/components/schemas/IncidentBody' incident_key: type: string description: A string which identifies the incident. Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key. assignments: type: array description: Assign the incident to these assignees. Cannot be specified if an escalation policy is given. items: properties: assignee: $ref: '#/components/schemas/UserReference' escalation_policy: $ref: '#/components/schemas/EscalationPolicyReference' conference_bridge: $ref: '#/components/schemas/ConferenceBridge' required: - type - title - service required: - incident examples: request: summary: Request Example value: incident: type: incident title: The server is on fire. service: id: PWIXJZS type: service_reference priority: id: P53ZZH5 type: priority_reference urgency: high incident_key: baf7cf21b1da41b4b0221008339ff357 body: type: incident_body details: A disk is getting full on this machine. You should investigate what is causing the disk to fill, and ensure that there is an automated process in place for ensuring data is rotated (eg. logs should have logrotate around them). If data is expected to stay on this disk forever, you should start planning to scale up to a larger disk. escalation_policy: id: PT20YPA type: escalation_policy_reference responses: '201': description: The incident object created. content: application/json: schema: type: object properties: incident: $ref: '#/components/schemas/Incident' required: - incident examples: response: summary: Response Example value: incident: id: PT4KHLK type: incident title: The server is on fire. summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: triggered incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PWIXJZS type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PWIXJZS html_url: https://subdomain.pagerduty.com/service-directory/PWIXJZS priority: id: P53ZZH5 type: priority_reference summary: P2 self: https://api.pagerduty.com/priorities/P53ZZH5 assigned_via: escalation_policy assignments: - at: '2015-11-10T00:31:52Z' assignee: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 resolved_at: null last_status_change_at: '2015-10-06T21:38:23Z' last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 urgency: high '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}: description: Get an incident. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: getIncident description: 'Show detailed information about an incident. Accepts either an incident id, or an incident number. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty Get an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/include_incident' responses: '200': description: The incident requested. content: application/json: schema: type: object properties: incident: $ref: '#/components/schemas/Incident' required: - incident examples: response: summary: Response Example value: incident: id: PT4KHLK type: incident summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 title: The server is on fire. created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: acknowledged incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 assignments: - at: '2015-11-10T00:31:52Z' assignee: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 assigned_via: escalation_policy last_status_change_at: '2015-10-06T21:38:23Z' resolved_at: null first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV alert_counts: all: 2 triggered: 1 resolved: 1 is_mergeable: true escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 pending_actions: - type: unacknowledge at: '2015-11-10T01:02:52Z' - type: resolve at: '2015-11-10T04:31:52Z' acknowledgements: - at: '2015-11-10T00:32:52Z' acknowledger: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 alert_grouping: grouping_type: advanced started_at: '2015-10-06T21:30:42Z' ended_at: null alert_grouping_active: true last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 priority: id: P53ZZH5 type: priority_reference summary: P2 self: https://api.pagerduty.com/priorities/P53ZZH5 resolve_reason: null conference_bridge: conference_number: +1-415-555-1212,,,,1234# conference_url: https://example.com/acb-123 incidents_responders: - state: pending user: id: PL7A2O4 type: user_reference summary: Lee Turner self: https://api.pagerduty.com/users/PL7A2O4 html_url: https://subdomain.pagerduty.com/users/PL7A2O4 avatar_url: https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG incident: id: PXP12GZ type: incident_reference summary: Ongoing Incident in Mailroom self: https://api.pagerduty.com/incidents/PXP12GZ html_url: https://subdomain.pagerduty.com/incidents/PXP12GZ updated_at: '2018-08-09T14:40:48-07:00' message: Please help with issue - join bridge at +1(234)-567-8910 requester: id: P09TT3C type: user_reference summary: Jane Doe self: https://api.pagerduty.com/users/P09TT3C html_url: https://subdomain.pagerduty.com/users/P09TT3C avatar_url: https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG requested_at: '2018-08-09T21:40:49Z' responder_requests: - incident: id: PXP12GZ type: incident_reference summary: Ongoing Incident in Mailroom self: https://api.pagerduty.com/incidents/PXP12GZ html_url: https://subdomain.pagerduty.com/incidents/PXP12GZ requester: id: P09TT3C type: user_reference summary: Jane Doe self: https://api.pagerduty.com/users/P09TT3C html_url: https://subdomain.pagerduty.com/users/P09TT3C requested_at: '2018-08-16T14:55:17-07:00' message: Please help with issue - join bridge at +1(234)-567-8910 responder_request_targets: - responder_request_target: type: user id: PL7A2O4 incidents_responders: - state: pending user: id: PL7A2O4 type: user_reference summary: Lee Turner self: https://api.pagerduty.com/users/PL7A2O4 html_url: https://subdomain.pagerduty.com/users/PL7A2O4 avatar_url: https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG incident: id: PXP12GZ type: incident_reference summary: Ongoing Incident in Mailroom self: https://api.pagerduty.com/incidents/PXP12GZ html_url: https://subdomain.pagerduty.com/incidents/PXP12GZ updated_at: '2018-08-09T14:40:48-07:00' message: Please help with issue - join bridge at +1(234)-567-8910 requester: id: P09TT3C type: user_reference summary: Jane Doe self: https://api.pagerduty.com/users/P09TT3C html_url: https://subdomain.pagerduty.com/users/P09TT3C avatar_url: https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG requested_at: '2018-08-09T21:40:49Z' urgency: high custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: single_value_fixed value: production '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' put: x-pd-requires-scope: incidents.write tags: - Incidents operationId: updateIncident description: 'Acknowledge, resolve, escalate or reassign an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Update an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: incident: type: object description: The parameters of the incident to update. properties: type: type: string description: The incident type. enum: - incident - incident_reference status: type: string description: The new status of the incident. enum: - resolved - acknowledged priority: $ref: '#/components/schemas/PriorityReference' resolution: type: string description: The resolution for this incident if status is set to resolved. title: type: string description: The new title of the incident. escalation_level: type: integer description: Escalate the incident to this level in the escalation policy. assignments: type: array description: Assign the incident to these assignees. items: properties: assignee: $ref: '#/components/schemas/UserReference' escalation_policy: $ref: '#/components/schemas/EscalationPolicyReference' urgency: type: string description: The urgency of the incident. enum: - high - low conference_bridge: $ref: '#/components/schemas/ConferenceBridge' required: - type required: - incident examples: request: summary: Request Example value: incident: type: incident_reference status: acknowledged responses: '200': description: The incident was updated. content: application/json: schema: allOf: - type: object properties: incident: $ref: '#/components/schemas/Incident' required: - incident examples: response: summary: Response Example value: incident: id: PT4KHLK type: incident summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: resolved title: The server is on fire. pending_actions: - type: unacknowledge at: '2015-11-10T01:02:52Z' - type: resolve at: '2015-11-10T04:31:52Z' incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 priority: id: P53ZZH5 type: priority_reference summary: P2 self: https://api.pagerduty.com/priorities/P53ZZH5 assigned_via: escalation_policy assignments: - at: '2015-11-10T00:31:52Z' assignee: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 acknowledgements: - at: '2015-11-10T00:32:52Z' acknowledger: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 resolved_at: '2015-10-06T21:38:23Z' last_status_change_at: '2015-10-06T21:38:23Z' last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 urgency: high '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/alerts: description: List and update alerts. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: listIncidentAlerts description: 'List alerts for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty List alerts for an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/offset_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/offset_total' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/alert_key' - $ref: '#/components/parameters/statuses_incident_alerts' - $ref: '#/components/parameters/sort_by_incident_alerts' - $ref: '#/components/parameters/include_incident_alerts' responses: '200': description: A paginated array of the incident's alerts. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: alerts: type: array items: $ref: '#/components/schemas/Alert' required: - alerts examples: response: summary: Response Example value: alerts: - id: PT4KHLK type: alert summary: The server is on fire. self: https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42 html_url: https://subdomain.pagerduty.com/alerts/PXPGF42 created_at: '2015-10-06T21:30:42Z' status: resolved alert_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 body: type: alert_body contexts: - type: link details: customKey: Server is on fire! customKey2: Other stuff! incident: id: PT4KHLK type: incident_reference suppressed: false severity: critical integration: id: PQ12345 type: generic_email_inbound_integration_reference summary: Email Integration self: https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345 html_url: https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345 limit: 1 offset: 0 more: true '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' put: x-pd-requires-scope: incidents.write tags: - Incidents operationId: updateIncidentAlerts description: 'Resolve multiple alerts or associate them with different incidents. An incident represents a problem or an issue that needs to be addressed and resolved. An alert represents a digital signal that was emitted to PagerDuty by the monitoring systems that detected or identified the issue. A maximum of 500 alerts may be updated at a time. If more than this number of alerts are given, the API will respond with status 413 (Request Entity Too Large). For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Manage alerts parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/offset_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/offset_total' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: alerts: type: array description: An array of alerts, including the parameters to update for each alert. items: $ref: '#/components/schemas/Alert' required: - alerts examples: request: summary: Request Example value: alerts: - id: PPVZH9X type: alert status: resolved - id: P8JOGX7 type: alert incident: id: PPVZH9X type: incident_reference responses: '200': description: All of the updates succeeded. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: alerts: type: array items: $ref: '#/components/schemas/Alert' required: - alerts examples: response: summary: Response Example value: alerts: - id: PT4KHLK type: alert summary: The server is on fire. self: https://api.pagerduty.com/incidents/PT4KHLK/alerts/PXPGF42 html_url: https://subdomain.pagerduty.com/alerts/PXPGF42 created_at: '2015-10-06T21:30:42Z' status: resolved alert_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 body: type: alert_body contexts: - type: link details: customKey: Server is on fire! customKey2: Other stuff! incident: id: PPVZH9X type: incident_reference suppressed: false severity: critical limit: 1 offset: 0 more: true '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '413': $ref: '#/components/responses/RequestEntityTooLarge' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/alerts/{alert_id}: description: Get an alert. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: getIncidentAlert description: 'Show detailed information about an alert. Accepts an alert id. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty Get an alert parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/alert_id' responses: '200': description: The alert requested. content: application/json: schema: type: object properties: alert: $ref: '#/components/schemas/Alert' required: - alert examples: response: summary: Response Example value: alert: id: PT4KHLK type: alert summary: The server is on fire. self: https://api.pagerduty.com/incident/PT4KHLX/alerts/PT4KHLK html_url: https://subdomain.pagerduty.com/alerts/PT4KHLK created_at: '2015-10-06T21:30:42Z' status: resolved alert_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 incident: id: PT4KHLX type: incident_reference summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLX html_url: https://subdomain.pagerduty.com/incidents/PT4KHLX suppressed: false severity: critical integration: id: PQ12345 type: generic_email_inbound_integration_reference summary: Email Integration self: https://api.pagerduty.com/services/PIJ90N7/integrations/PQ12345 html_url: https://subdomain.pagerduty.com/services/PIJ90N7/integrations/PQ12345 '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' put: x-pd-requires-scope: incidents.write tags: - Incidents operationId: updateIncidentAlert description: 'Resolve an alert or associate an alert with a new parent incident. An incident represents a problem or an issue that needs to be addressed and resolved. When a service sends an event to PagerDuty, an alert and corresponding incident is triggered in PagerDuty. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Update an alert parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/alert_id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: alert: $ref: '#/components/schemas/Alert' required: - alert examples: request: summary: Request Example value: alert: type: alert status: resolved incident: id: PEYSGVF type: incident_reference body: type: alert_body contexts: - type: link details: customKey: Server is on fire! customKey2: Other stuff! description: The parameters of the alert to update. responses: '200': description: The alert that was updated. content: application/json: schema: type: object properties: alert: $ref: '#/components/schemas/Alert' required: - alert examples: request: summary: Request Example value: alert: type: alert status: resolved incident: id: PEYSGVF type: incident_reference body: type: alert_body contexts: - type: link details: customKey: Server is on fire! customKey2: Other stuff! '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/business_services/{business_service_id}/impacts: put: x-pd-requires-scope: incidents.write summary: PagerDuty Manually change an Incident's Impact on a Business Service. tags: - Incidents responses: '200': description: OK content: application/json: schema: description: '' type: object properties: relation: type: string enum: - impacted - not_impacted examples: response: summary: Response Example value: relation: impacted '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' operationId: putIncidentManualBusinessServiceAssociation description: 'Change Impact of an Incident on a Business Service. Scoped OAuth requires: `incidents.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/business_service_id' requestBody: content: application/json: schema: description: '' type: object properties: relation: type: string enum: - impacted - not_impacted required: - relation description: 'The `impacted` relation will cause the Business Service and any Services that it supports to become impacted by this incident. The `not_impacted` relation will remove the Incident''s Impact from the specified Business Service. The effect of adding or removing Impact to a Business Service in this way will also change the propagation of Impact to other Services supported by that Business Service.' /incidents/{id}/business_services/impacts: get: x-pd-requires-scope: incidents.read summary: PagerDuty List Business Services impacted by the given Incident tags: - Incidents responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/CursorPagination' - type: object properties: services: type: array items: $ref: '#/components/schemas/Impact' examples: response: summary: Response Example value: limit: 100 next_cursor: null services: - id: PD1234 name: Web API type: business_service status: impacted - id: PF9KMXH name: Analytics Backend type: business_service status: impacted '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' operationId: getIncidentImpactedBusinessServices description: 'Retrieve a list of Business Services that are being impacted by the given Incident. Scoped OAuth requires: `incidents.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/id' /incidents/{id}/custom_fields/values: description: Retrieve and update incident custom fields. get: tags: - Incidents x-pd-requires-scope: incidents.read operationId: getIncidentFieldValues description: 'Get custom field values for an incident. Scoped OAuth requires: `incidents.read` ' summary: PagerDuty Get Custom Field Values parameters: - $ref: '#/components/parameters/id' responses: '200': description: The list of custom field values. content: application/json: schema: type: object properties: custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldsFieldValue' required: - custom_fields examples: response1: summary: Response Example value: custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: single_value_fixed value: production response2: summary: Response Example value: custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: multi_value_fixed value: - production - staging '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' put: tags: - Incidents x-pd-requires-scope: incidents.write operationId: setIncidentFieldValues description: 'Set custom field values for an incident. Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Update Custom Field Values parameters: - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: type: object properties: custom_fields: type: array title: Array of Custom Field Values items: $ref: '#/components/schemas/CustomFieldsEditableFieldValue' required: - custom_fields examples: request1: summary: Request Example value: custom_fields: - name: environment value: production request2: summary: Request Example value: custom_fields: - id: PT4KHEE value: production request3: summary: Request Example value: custom_fields: - id: PT4KHEE value: - production - staging responses: '201': description: Custom field values were updated. content: application/json: schema: type: object properties: custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldsFieldValue' required: - custom_fields examples: response1: summary: Response Example value: custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: single_value_fixed value: production response2: summary: Response Example value: custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: single_value_fixed value: production response3: summary: Response Example value: custom_fields: - id: PT4KHEE type: field_value name: environment display_name: Runtime Environment description: environment where incident occurred data_type: string field_type: multi_value_fixed value: - production - staging '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' /incidents/{id}/log_entries: description: List incident log entries for an incident. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: listIncidentLogEntries description: 'List log entries for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A Log Entry are a record of all events on your account. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty List log entries for an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/offset_limit' - $ref: '#/components/parameters/offset_offset' - $ref: '#/components/parameters/offset_total' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/time_zone' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/until' - $ref: '#/components/parameters/log_entry_is_overview' - $ref: '#/components/parameters/include_log_entry' responses: '200': description: A paginated array of the incident's log entries. content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: log_entries: type: array items: oneOf: - $ref: '#/components/schemas/AcknowledgeLogEntry' - $ref: '#/components/schemas/AnnotateLogEntry' - $ref: '#/components/schemas/AssignLogEntry' - $ref: '#/components/schemas/DelegateLogEntry' - $ref: '#/components/schemas/EscalateLogEntry' - $ref: '#/components/schemas/ExhaustEscalationPathLogEntry' - $ref: '#/components/schemas/NotifyLogEntry' - $ref: '#/components/schemas/ReachAckLimitLogEntry' - $ref: '#/components/schemas/ReachTriggerLimitLogEntry' - $ref: '#/components/schemas/RepeatEscalationPathLogEntry' - $ref: '#/components/schemas/ResolveLogEntry' - $ref: '#/components/schemas/SnoozeLogEntry' - $ref: '#/components/schemas/TriggerLogEntry' - $ref: '#/components/schemas/UnacknowledgeLogEntry' - $ref: '#/components/schemas/UrgencyChangeLogEntry' required: - log_entries examples: response: summary: Response Example value: log_entries: - id: Q02JTSNZWHSEKV type: trigger_log_entry summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV created_at: '2015-11-07T00:14:20Z' agent: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 channel: type: api incident: id: PT4KHLK type: incident_reference summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 contexts: [] event_details: description: Tasks::SFDCValidator - PD_Data__c - duplicates '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/merge: description: '"Merge" an array of incidents into a target incident. After the merge is performed the target incident will contain the source incidents''s alerts, and the source incidents will be resolved.' put: tags: - Incidents x-pd-requires-scope: incidents.write operationId: mergeIncidents description: 'Merge a list of source incidents into this incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Merge incidents parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: source_incidents: type: array description: The source incidents that will be merged into the target incident and resolved. items: $ref: '#/components/schemas/IncidentReference' required: - source_incidents examples: request: summary: Request Example value: source_incidents: - id: P8JOGX7 type: incident_reference - id: PPVZH9X type: incident_reference responses: '200': description: The target incident, which now contains all the alerts from the source incident. content: application/json: schema: type: object properties: incident: $ref: '#/components/schemas/IncidentReference' required: - incident examples: response: summary: Response Example value: incident: id: PT4KHLK type: incident_reference summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/notes: description: List and create incident notes. get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: listIncidentNotes description: 'List existing notes for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty List notes for an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' responses: '200': description: An array of notes. content: application/json: schema: type: object properties: notes: type: array items: $ref: '#/components/schemas/IncidentNote' required: - notes examples: response: summary: Response Example value: notes: - id: PWL7QXS user: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 channel: summary: The PagerDuty website or APIs content: Firefighters are on the scene. created_at: '2013-03-06T15:28:51-05:00' - id: PCQC25 user: id: PXPGF42 type: bot_user_reference summary: A Global Event Rule self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b channel: id: 14e56445-ebab-4dd0-ba9d-fc28a41b7e7b type: event_rule_reference summary: A Global Event Rule self: https://api.pagerduty.com/rulesets/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b html_url: https://subdomain.pagerduty.com/event-rules/global/0e84de00-9511-4380-9f4f-a7b568bb49a0/rules/14e56445-ebab-4dd0-ba9d-fc28a41b7e7b content: Initial alert information indicates a 1-alarm fire created_at: '2013-03-06T15:28:42-05:00' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' post: tags: - Incidents x-pd-requires-scope: incidents.write operationId: createIncidentNote description: 'Create a new note for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. A maximum of 2000 notes can be added to an incident. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Create a note on an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: note: type: object properties: content: type: string description: The note content required: - content required: - note examples: request: summary: Request Example value: note: content: Firefighters are on the scene. responses: '200': description: The new note. content: application/json: schema: type: object properties: note: $ref: '#/components/schemas/IncidentNote' required: - note examples: response: summary: Response Example value: note: id: PWL7QXS user: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 channel: summary: The PagerDuty website or APIs content: Firefighters are on the scene. created_at: '2013-03-06T15:28:51-05:00' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/outlier_incident: description: Get Outlier Incident get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: getOutlierIncident description: 'Gets Outlier Incident information for a given Incident on its Service. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#outlier-incident) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty Get Outlier Incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/additional_details' responses: '200': description: Outlier Incident information calculated over the same Service as the given Incident. content: application/json: schema: description: '' type: object properties: outlier_incident: type: object description: Outlier Incident information calculated over the same Service as the given Incident. properties: incident: $ref: '#/components/schemas/Incident' incident_template: type: object properties: id: type: string readOnly: true cluster_id: type: string readOnly: true description: The cluster the Incident Template pattern belongs to mined_text: type: string readOnly: true description: The Incident Template mined pattern text examples: response: summary: Response Example value: outlier_incident: incident: id: PR2P3RW created_at: '2020-11-18T13:08:14Z' self: https://api.pagerduty.com/incidents/PR2P3RW title: '[LINUX]Used disk space is more than 5 GB on volume /var/log : PROBLEM for ce51323' occurrence: count: 10 frequency: 0.04 category: rare since: '2020-09-23T13:08:14Z' until: '2021-01-18T13:08:14Z' incident_template: id: PX3P1PX cluster_id: P2B3X5 mined_text: '[LINUX]Used disk space is more than on volume <*> : PROBLEM for <*>' '400': $ref: '#/components/responses/ArgumentError' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /incidents/{id}/past_incidents: parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' get: x-pd-requires-scope: incidents.read summary: PagerDuty Get Past Incidents tags: - Incidents responses: '200': description: OK content: application/json: schema: description: '' type: object properties: past_incidents: type: array description: Aggregate of past incidents items: type: object properties: incident: type: object description: Incident model reference properties: id: type: string description: The globally unique identifier of the incident created_at: type: string description: The date/time the incident was first triggered self: type: string description: The URL at which the object is accessible title: type: string description: The description of the nature, symptoms, cause, or effect of the incident score: type: number description: 'The computed similarity score associated with the incident and parent incident ' total: type: number description: The total number of Past Incidents if the total parameter was set in the request limit: type: number description: The maximum number of Incidents requested examples: response: summary: Response Example value: past_incidents: - incident: id: PFBE9I2 created_at: '2020-11-04T16:08:15Z' self: https://api.pagerduty.com/incidents/PFBE9I2 title: Things are so broken! score: 46.8249 - incident: id: P1J6V6M created_at: '2020-10-22T17:18:14Z' self: https://api.pagerduty.com/incidents/P1J6V6M title: Things are so broken! score: 46.8249 - incident: id: P6HPX5N created_at: '2020-10-06T22:01:13Z' self: https://api.pagerduty.com/incidents/P6HPX5N title: You forgot to feed the cat! score: 0 total: 3 limit: 5 '400': $ref: '#/components/responses/ArgumentError' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' operationId: getPastIncidents parameters: - $ref: '#/components/parameters/past_incidents_limit' - $ref: '#/components/parameters/past_incidents_total' description: 'Past Incidents returns Incidents within the past 6 months that have similar metadata and were generated on the same Service as the parent Incident. By default, 5 Past Incidents are returned. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#past_incidents) Scoped OAuth requires: `incidents.read` ' /incidents/{id}/related_incidents: description: Get Related Incidents get: x-pd-requires-scope: incidents.read tags: - Incidents operationId: getRelatedIncidents description: 'Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#related_incidents) Scoped OAuth requires: `incidents.read` ' summary: PagerDuty Get Related Incidents parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/additional_details' responses: '200': description: A list of Related Incidents and their relationships. content: application/json: schema: description: '' type: object properties: related_incidents: type: array description: A list of Related Incidents and their relationships. items: properties: incident: $ref: '#/components/schemas/Incident' relationships: type: array description: A list of reasons for why the Incident is considered related. items: properties: type: type: string description: The type of relationship. A relationship outlines the reason why two Incidents are considered related. enum: - machine_learning_inferred - service_dependency metadata: anyOf: - $ref: '#/components/schemas/RelatedIncidentMachineLearningRelationship' - $ref: '#/components/schemas/RelatedIncidentServiceDependencyRelationship' examples: response: summary: Response Example value: related_incidents: - incident: id: PR2P3RW created_at: '2020-11-18T13:08:14Z' self: https://api.pagerduty.com/incidents/PR2P3RW title: The server is on fire. relationships: - type: machine_learning_inferred metadata: grouping_classification: similar_contents user_feedback: positive_feedback_count: 12 negative_feedback_count: 3 - type: service_dependency metadata: dependent_services: id: P1L1YEE type: business_service_reference self: https://api.pagerduty.com/business_services/P1L1YEE supporting_services: id: PNGCNV2 type: technical_service_reference self: https://api.pagerduty.com/services/PNGCNV2 '400': $ref: '#/components/responses/ArgumentError' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' /incidents/{id}/responder_requests: description: Add responders to an incident. post: x-pd-requires-scope: incidents.write tags: - Incidents operationId: createIncidentResponderRequest description: 'Send a new responder request for the specified incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Create a responder request for an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: requester_id: type: string description: The user id of the requester. message: type: string description: The message sent with the responder request. responder_request_targets: description: The array of targets the responder request is sent to. items: $ref: '#/components/schemas/ResponderRequestTargetReference' required: - requester_id - message - responder_request_targets examples: request: summary: Request Example value: requester_id: PL1JMK5 message: Please help with issue - join bridge at +1(234)-567-8910 responder_request_targets: - responder_request_target: id: PJ25ZYX type: user_reference responses: '200': description: The new responder request for the given incident. content: application/json: schema: type: object properties: responder_request: $ref: '#/components/schemas/ResponderRequest' required: - responder_request examples: response: summary: Response Example value: responder_request: incident: id: PXP12GZ type: incident_reference summary: Ongoing Incident in Mailroom self: https://api.pagerduty.com/incidents/PXP12GZ html_url: https://subdomain.pagerduty.com/incidents/PXP12GZ requester: id: P09TT3C type: user_reference summary: Jane Doe self: https://api.pagerduty.com/users/P09TT3C html_url: https://subdomain.pagerduty.com/users/P09TT3C requested_at: '2018-08-16T14:55:17-07:00' message: Please help with issue - join bridge at +1(234)-567-8910 responder_request_targets: - responder_request_target: type: user id: PL7A2O4 incidents_responders: - state: pending user: id: PL7A2O4 type: user_reference summary: Lee Turner self: https://api.pagerduty.com/users/PL7A2O4 html_url: https://subdomain.pagerduty.com/users/PL7A2O4 avatar_url: https://secure.gravatar.com/avatar/51c673f51f6b483b24c889bbafbd2a67.png?d=mm&r=PG incident: id: PXP12GZ type: incident_reference summary: Ongoing Incident in Mailroom self: https://api.pagerduty.com/incidents/PXP12GZ html_url: https://subdomain.pagerduty.com/incidents/PXP12GZ updated_at: '2018-08-09T14:40:48-07:00' message: Please help with issue - join bridge at +1(234)-567-8910 requester: id: P09TT3C type: user_reference summary: Jane Doe self: https://api.pagerduty.com/users/P09TT3C html_url: https://subdomain.pagerduty.com/users/P09TT3C avatar_url: https://secure.gravatar.com/avatar/1c747247b75acc1f724e2784c838b3f8.png?d=mm&r=PG requested_at: '2018-08-09T21:40:49Z' '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/snooze: description: '"Snooze" an incident. This suspends the acknowledgement timeout and auto-resolution for a given amount of time.' post: tags: - Incidents x-pd-requires-scope: incidents.write operationId: createIncidentSnooze description: 'Snooze an incident. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Snooze an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: duration: type: integer description: The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the "triggered" state. minimum: 1 maximum: 604800 required: - duration examples: request: summary: Request Example value: duration: 3600 responses: '201': description: The incident that was successfully snoozed. content: application/json: schema: type: object properties: incident: $ref: '#/components/schemas/Incident' required: - incident examples: response: summary: Response Example value: incident: id: PT4KHLK type: incident summary: '[#1234] The server is on fire.' self: https://api.pagerduty.com/incidents/PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK incident_number: 1234 created_at: '2015-10-06T21:30:42Z' updated_at: '2015-10-06T21:40:23Z' status: resolved pending_actions: - type: unacknowledge at: '2015-11-10T01:02:52Z' - type: resolve at: '2015-11-10T04:31:52Z' incident_key: baf7cf21b1da41b4b0221008339ff357 service: id: PIJ90N7 type: service_reference summary: My Mail Service self: https://api.pagerduty.com/services/PIJ90N7 html_url: https://subdomain.pagerduty.com/service-directory/PIJ90N7 assigned_via: escalation_policy assignments: - at: '2015-11-10T00:31:52Z' assignee: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 acknowledgements: - at: '2015-11-10T00:32:52Z' acknowledger: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 resolved_at: '2015-10-06T21:38:23Z' last_status_change_at: '2015-10-06T21:38:23Z' last_status_change_by: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 first_trigger_log_entry: id: Q02JTSNZWHSEKV type: trigger_log_entry_reference summary: Triggered through the API self: https://api.pagerduty.com/log_entries/Q02JTSNZWHSEKV?incident_id=PT4KHLK html_url: https://subdomain.pagerduty.com/incidents/PT4KHLK/log_entries/Q02JTSNZWHSEKV escalation_policy: id: PT20YPA type: escalation_policy_reference summary: Another Escalation Policy self: https://api.pagerduty.com/escalation_policies/PT20YPA html_url: https://subdomain.pagerduty.com/escalation_policies/PT20YPA teams: - id: PQ9K7I8 type: team_reference summary: Engineering self: https://api.pagerduty.com/teams/PQ9K7I8 html_url: https://subdomain.pagerduty.com/teams/PQ9K7I8 urgency: high '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/status_updates: description: Create incident status updates. post: x-pd-requires-scope: incidents.write tags: - Incidents operationId: createIncidentStatusUpdate description: 'Create a new status update for the specified incident. Optionally pass `subject` and `html_message` properties in the request body to override the email notification that gets sent. An incident represents a problem or an issue that needs to be addressed and resolved. For more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#incidents) Scoped OAuth requires: `incidents.write` ' summary: PagerDuty Create a status update on an incident parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/header_Content-Type' - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/from_header' requestBody: content: application/json: schema: type: object properties: message: type: string description: The message to be posted as a status update. subject: type: string description: The subject to be sent for the custom html email status update. Required if sending custom html email. html_message: type: string description: The html content to be sent for the custom html email status update. Required if sending custom html email. required: - message examples: request: summary: Request Example value: message: The server fire is spreading. subject: Server Fire Update html_message:

Server is still on fire

responses: '200': description: The new status update for the specified incident. content: application/json: schema: type: object properties: status_update: $ref: '#/components/schemas/StatusUpdate' required: - status_update examples: response: summary: Response Example value: status_update: id: PWL7QXS message: The server fire is spreading. sender: id: PXPGF42 type: user_reference summary: Earline Greenholt self: https://api.pagerduty.com/users/PXPGF42 html_url: https://subdomain.pagerduty.com/users/PXPGF42 created_at: '2013-03-06T15:28:51-05:00' html_message:

Server is still on fire

subject: Server Fire Update '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' /incidents/{id}/status_updates/subscribers: get: x-pd-requires-scope: subscribers.read summary: PagerDuty List Notification Subscribers tags: - Incidents responses: '200': description: OK content: application/json: schema: allOf: - $ref: '#/components/schemas/Pagination' - type: object properties: subscribers: type: array items: $ref: '#/components/schemas/NotificationSubscriberWithContext' - type: object properties: account_id: type: string description: The ID of the account belonging to the subscriber entity examples: response: summary: Response Example value: limit: 100 more: false offset: 0 subscribers: - subscriber_id: PD1234 subscriber_type: user has_indirect_subscription: false subscribed_via: null - subscriber_id: PD1234 subscriber_type: team has_indirect_subscription: true subscribed_via: - id: PD1234 type: business_service account_id: PD1234 total: 2 '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' operationId: getIncidentNotificationSubscribers description: 'Retrieve a list of Notification Subscribers on the Incident. > Users must be added through `POST /incident/{id}/status_updates/subscribers` to be returned from this endpoint. Scoped OAuth requires: `subscribers.read` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/id' post: x-pd-requires-scope: subscribers.write summary: PagerDuty Add Notification Subscribers operationId: createIncidentNotificationSubscribers tags: - Incidents responses: '200': description: OK content: application/json: schema: type: object properties: subscriptions: type: array items: $ref: '#/components/schemas/NotificationSubscriptionWithContext' examples: response: summary: Response Example value: subscriptions: - account_id: PD1234 subscribable_id: PD1234 subscribable_type: incident subscriber_id: PD1234 subscriber_type: user result: success - account_id: PD1234 subscribable_id: PD1234 subscribable_type: incident subscriber_id: PD1234 subscriber_type: team result: duplicate - account_id: PD1234 subscribable_id: PD1235 subscribable_type: incident subscriber_id: PD1234 subscriber_type: team result: unauthorized '400': $ref: '#/components/responses/ArgumentError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' description: 'Subscribe the given entities to Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: type: object properties: subscribers: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/NotificationSubscriber' required: - subscribers examples: request: summary: Request Example value: subscribers: - subscriber_id: PD1234 subscriber_type: team - subscriber_id: PD1235 subscriber_type: team - subscriber_id: PD1234 subscriber_type: user description: The entities to subscribe. /incidents/{id}/status_updates/unsubscribe: post: x-pd-requires-scope: subscribers.write summary: PagerDuty Remove Notification Subscriber tags: - Incidents responses: '200': description: OK content: application/json: schema: type: object properties: deleted_count: type: number unauthorized_count: type: number non_existent_count: type: number required: - deleted_count - unauthorized_count - non_existent_count examples: response: summary: Response Example value: deleted_count: 1 unauthorized_count: 1 non_existent_count: 0 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/UnprocessableEntity' operationId: removeIncidentNotificationSubscribers description: 'Unsubscribes the matching Subscribers from Incident Status Update Notifications. Scoped OAuth requires: `subscribers.write` ' parameters: - $ref: '#/components/parameters/header_Accept' - $ref: '#/components/parameters/id' requestBody: content: application/json: schema: type: object properties: subscribers: type: array uniqueItems: true minItems: 1 items: $ref: '#/components/schemas/NotificationSubscriber' required: - subscribers examples: request: summary: Request Example value: subscribers: - subscriber_id: PD1234 subscriber_type: team - subscriber_id: PD1234 subscriber_type: user description: The entities to unsubscribe. components: parameters: log_entry_is_overview: name: is_overview in: query description: If `true`, will return a subset of log entries that show only the most important changes to the incident. required: false schema: type: boolean default: false header_Accept: name: Accept description: The `Accept` header is used as a versioning header. in: header required: true schema: type: string default: application/vnd.pagerduty+json;version=2 header_Content-Type: name: Content-Type in: header required: true schema: type: string default: application/json enum: - application/json offset_total: name: total in: query required: false 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. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information. ' schema: default: false type: boolean incident_assigned_to_user: name: user_ids[] in: query description: 'Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.' explode: true schema: type: array items: type: string uniqueItems: true additional_details: name: additional_details[] in: query description: Array of additional attributes to any of the returned incidents for related incidents. explode: true schema: type: string enum: - incident uniqueItems: true include_log_entry: name: include[] in: query description: Array of additional Models to include in response. explode: true schema: type: string enum: - incidents - services - channels - teams uniqueItems: true from_header: name: From in: header description: The email address of a valid user associated with the account making the request. required: true schema: type: string format: email alert_key: name: alert_key in: query description: Alert de-duplication key. schema: type: string include_incidents: name: include[] description: Array of additional details to include. explode: true in: query schema: type: string enum: - acknowledgers - agents - assignees - conference_bridge - escalation_policies - first_trigger_log_entries - priorities - services - teams - users uniqueItems: true include_incident_alerts: name: include[] in: query description: Array of additional details to include. explode: true schema: type: string enum: - services - first_trigger_log_entries - incidents uniqueItems: true date_range: name: date_range in: query description: When set to all, the since and until parameters and defaults are ignored. schema: type: string enum: - all id: name: id description: The ID of the resource. in: path required: true schema: type: string statuses_incident_alerts: name: statuses[] in: query description: Return only alerts with the given statuses. (More status codes may be introduced in the future.) explode: true schema: type: string enum: - triggered - resolved uniqueItems: true statuses_incidents: name: statuses[] in: query description: 'Return only incidents with the given statuses. To query multiple statuses, pass `statuses[]` more than once, for example: `https://api.pagerduty.com/incidents?statuses[]=triggered&statuses[]=acknowledged`. (More status codes may be introduced in the future.)' explode: true schema: type: string enum: - triggered - acknowledged - resolved uniqueItems: true incident_services: name: service_ids[] in: query description: Returns only the incidents associated with the passed service(s). This expects one or more service IDs. explode: true schema: type: array items: type: string uniqueItems: true offset_limit: name: limit in: query required: false description: The number of results per page. schema: type: integer until_incidents: schema: type: string in: query name: until description: The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month. alert_id: name: alert_id in: path description: The id of the alert to retrieve. required: true schema: type: string incident_key: name: incident_key in: query description: Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key. schema: type: string offset_offset: name: offset in: query required: false description: Offset to start pagination search results. schema: type: integer until: name: until in: query description: The end of the date range over which you want to search. schema: type: string format: date-time past_incidents_limit: name: limit in: query required: false description: The number of results to be returned in the response. schema: type: integer default: 5 minimum: 1 maximum: 999 business_service_id: name: business_service_id in: path description: The business service ID. required: true schema: type: string since: name: since in: query description: The start of the date range over which you want to search. schema: type: string format: date-time incident_urgencies: name: urgencies[] in: query description: Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the `urgencies` ability to do this. explode: true schema: type: string enum: - high - low uniqueItems: true team_ids: name: team_ids[] in: 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. explode: true schema: type: array items: type: string uniqueItems: true past_incidents_total: name: total in: query required: false description: 'By default the `total` field in the response body is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated with the total number of Past Incidents. ' schema: type: boolean default: false time_zone: name: time_zone in: query description: Time zone in which results will be rendered. This will default to the account time zone. schema: type: string format: tzinfo include_incident: name: include[] in: query description: Array of additional details to include. explode: true schema: type: string enum: - acknowledgers - agents - assignees - conference_bridge - custom_fields - escalation_policies - first_trigger_log_entries - priorities - services - teams - users uniqueItems: true sort_by_incidents: name: sort_by in: query description: Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the `urgencies` ability to sort by the urgency. style: form explode: false schema: type: array items: type: string maxItems: 2 uniqueItems: true incident_list_limit: name: limit in: query required: false description: The number of results per page. Maximum of 10000. schema: type: integer sort_by_incident_alerts: name: sort_by in: query description: Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. style: form explode: false schema: type: string enum: - created_at - resolved_at - created_at:asc - created_at:desc - resolved_at:asc - resolved_at:desc maxItems: 2 uniqueItems: true since_incidents: schema: type: string in: query name: since description: The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month. schemas: EscalationRule: type: object properties: id: type: string readOnly: true escalation_delay_in_minutes: type: integer description: The number of minutes before an unacknowledged incident escalates away from this rule. targets: type: array minItems: 1 maxItems: 10 description: The targets an incident should be assigned to upon reaching this rule. items: $ref: '#/components/schemas/EscalationTargetReference' escalation_rule_assignment_strategy: type: string description: The strategy used to assign the escalation rule to an incident. enum: - round_robin - assign_to_everyone required: - escalation_delay_in_minutes - targets example: escalation_delay_in_minutes: 30 targets: - id: PAM4FGS type: user_reference - id: PI7DH85 type: schedule_reference NotifyLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: created_at: type: string format: date-time readOnly: true description: Time at which the log entry was created user: $ref: '#/components/schemas/UserReference' type: type: string enum: - notify_log_entry ResolveLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - resolve_log_entry IncidentNote: type: object properties: id: type: string readOnly: true user: allOf: - $ref: '#/components/schemas/Reference' - type: object description: The user who created a Note. If a service created this Note the `user.type` will be "bot_user_reference" and `user.summary` will list the name of the service rather than the user. properties: type: type: string enum: - user_reference - bot_user_reference channel: type: object readOnly: true description: The means by which this Note was created. Has different formats depending on type. properties: summary: type: string description: A string describing the source of the Note. readOnly: true id: type: string readOnly: true type: type: string description: A string that determines the schema of the object readOnly: true self: type: string format: url description: The API show URL at which the object is accessible readOnly: true html_url: type: string format: url description: a URL at which the entity is uniquely displayed in the Web app readOnly: true required: - summary content: type: string description: The note content created_at: type: string format: date-time description: The time at which the note was submitted readOnly: true required: - content example: content: Firefighters are on the scene. Impact: title: Impact type: object properties: id: type: string readOnly: true name: type: string readOnly: true type: type: string description: The kind of object that has been impacted enum: - business_service status: type: string description: The current impact status of the object enum: - impacted - not_impacted additional_fields: type: object properties: highest_impacting_priority: type: object nullable: true description: Priority information for the highest priority level that is affecting the impacted object. properties: id: type: string readOnly: true order: type: integer readOnly: true Notification: type: object properties: id: type: string readOnly: true type: type: string description: The type of notification. enum: - sms_notification - email_notification - phone_notification - push_notification readOnly: true started_at: type: string format: date-time description: The time at which the notification was sent readOnly: true address: type: string description: The address where the notification was sent. This will be null for notification type `push_notification`. readOnly: true user: $ref: '#/components/schemas/UserReference' conferenceAddress: type: string description: The address of the conference bridge status: type: string ? '' : type: string CustomFieldsFieldValue: type: object properties: id: type: string description: Id of the field. name: type: string title: Field Name description: The name of the field. May include ASCII characters, specifically lowercase letters, digits, and underescores. The `name` for a Field must be unique. maxLength: 50 type: type: string description: Determines the type of the reference. enum: - field_value display_name: type: string description: The human-readable name of the field. This must be unique across an account. maxLength: 50 field_type: type: string description: The type of data this field contains. In combination with the `data_type` field. enum: - single_value - single_value_fixed - multi_value - multi_value_fixed data_type: type: string description: The kind of data the custom field is allowed to contain. enum: - boolean - integer - float - string - datetime - url description: type: string nullable: true description: A description of the data this field contains. maxLength: 1000 value: oneOf: - type: object title: Boolean properties: value: type: boolean nullable: true - type: object title: Float properties: value: type: number nullable: true - type: object title: Integer properties: value: type: integer nullable: true - type: object title: String properties: value: oneOf: - type: string maxLength: 200 nullable: true - type: array items: type: string maxLength: 200 maxItems: 10 uniqueItems: true nullable: true - type: object title: Datetime properties: value: type: string nullable: true format: date-time - type: object title: Url properties: value: type: string format: uri maxLength: 200 nullable: true required: - id - type - name - value - display_name - data_type - field_type - description Context: type: object discriminator: propertyName: type properties: type: type: string description: The type of context being attached to the incident. enum: - link - image href: type: string description: The link's target url src: type: string description: The image's source url text: type: string description: The alternate display for an image required: - type ReachTriggerLimitLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - reach_trigger_limit_log_entry IncidentReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - incident_reference Team: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: type: type: string description: The type of object being created. default: team enum: - team name: type: string description: The name of the team. maxLength: 100 description: type: string description: The description of the team. maxLength: 1024 default_role: type: string description: The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager"). default: manager enum: - manager - none required: - name - type example: type: team name: Engineering description: The engineering team Priority: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: name: type: string description: The user-provided short name of the priority. description: type: string description: The user-provided description of the priority. Service: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: type: type: string description: The type of object being created. default: service enum: - service name: type: string description: The name of the service. description: type: string description: The user-provided description of the service. auto_resolve_timeout: type: integer description: Time in seconds that an incident is automatically resolved if left open for that long. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. default: 14400 acknowledgement_timeout: type: integer description: Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is `null` if the feature is disabled. Value must not be negative. Setting this field to `0`, `null` (or unset in POST request) will disable the feature. default: 1800 created_at: type: string format: date-time description: The date/time when this service was created readOnly: true status: type: string description: 'The current state of the Service. Valid statuses are: - `active`: The service is enabled and has no open incidents. This is the only status a service can be created with. - `warning`: The service is enabled and has one or more acknowledged incidents. - `critical`: The service is enabled and has one or more triggered incidents. - `maintenance`: The service is under maintenance, no new incidents will be triggered during maintenance mode. - `disabled`: The service is disabled and will not have any new triggered incidents. ' enum: - active - warning - critical - maintenance - disabled default: active last_incident_timestamp: type: string format: date-time description: The date/time when the most recent incident was created for this service. readOnly: true escalation_policy: $ref: '#/components/schemas/EscalationPolicyReference' response_play: deprecated: true description: Response plays associated with this service. allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - response_play_reference teams: type: array description: The set of teams associated with this service. items: $ref: '#/components/schemas/TeamReference' readOnly: true integrations: type: array description: An array containing Integration objects that belong to this service. If `integrations` is passed as an argument, these are full objects - otherwise, these are references. items: $ref: '#/components/schemas/IntegrationReference' readOnly: true incident_urgency_rule: $ref: '#/components/schemas/IncidentUrgencyRule' support_hours: $ref: '#/components/schemas/SupportHours' scheduled_actions: type: array description: An array containing scheduled actions for the service. items: $ref: '#/components/schemas/ScheduledAction' addons: type: array description: The array of Add-ons associated with this service. items: $ref: '#/components/schemas/AddonReference' readOnly: true alert_creation: type: string deprecated: true description: 'Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging. * "create_incidents" - The service will create one incident and zero alerts for each incoming event. * "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event. This attribute has been deprecated as all services will be migrated to use alerts and incidents. Afterward, the incident only service setting will no longer be available. For details, please refer to the knowledge base: https://support.pagerduty.com/docs/alerts#enable-and-disable-alerts-on-a-service. ' enum: - create_incidents - create_alerts_and_incidents default: create_alerts_and_incidents alert_grouping_parameters: $ref: '#/components/schemas/AlertGroupingParameters' alert_grouping: type: string deprecated: true description: 'Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options: * null - No alert grouping on the service. Each alert will create a separate incident; * "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the `alert_grouping_timeout` setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; * "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans ' enum: - time - intelligent alert_grouping_timeout: type: integer deprecated: true description: 'The duration in minutes within which to automatically group incoming alerts. This setting applies only when `alert_grouping` is set to `time`. To continue grouping alerts until the Incident is resolved, set this value to `0`. ' auto_pause_notifications_parameters: $ref: '#/components/schemas/AutoPauseNotificationsParameters' required: - type - escalation_policy example: id: PSI2I2O summary: string type: service self: string html_url: string name: My Web App description: My cool web application that does things. auto_resolve_timeout: 14400 acknowledgement_timeout: 600 status: active escalation_policy: id: PWIP6CQ type: escalation_policy_reference response_play: id: 1677af3c-44cf-50f4-6c68-818f7f514802 type: response_play_reference incident_urgency_rule: type: use_support_hours during_support_hours: type: constant urgency: high outside_support_hours: type: constant urgency: low support_hours: type: fixed_time_per_day time_zone: America/Lima start_time: 09:00:00 end_time: '17:00:00' days_of_week: - 1 - 2 - 3 - 4 - 5 scheduled_actions: - type: urgency_change at: type: named_time name: support_hours_start to_urgency: high alert_creation: create_alerts_and_incidents alert_grouping_parameters: type: time config: timeout: 2 auto_pause_notifications_parameters: enabled: true timeout: 300 IncidentBody: type: object properties: details: type: object description: Additional incident details. required: - type NotificationRuleReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - assignment_notification_rule_reference ContentBasedAlertGroupingConfiguration: type: object title: Content Only Grouping description: The configuration for Content Based Alert Grouping properties: aggregate: type: string description: Whether Alerts should be grouped if `all` or `any` specified fields match. If `all` is selected, an exact match on every specified field name must occur for Alerts to be grouped. If `any` is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields. enum: - all, any fields: type: array description: An array of strings which represent the fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match. time_window: type: integer minimum: 300 maximum: 86400 description: The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window up to 24 hours and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours (24 hours only applies to single-service settings). To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 <= time_window <= 3600 or 86400(i.e. 24 hours). recommended_time_window: readOnly: true type: integer description: In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service`s average Alert inter-arrival time. We encourage customer`s to use this value, please set `time_window` to 0 to use the `recommended_time_window`. Channel: type: object description: Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of `auto`, `email`, `api`, `nagios`, or `timeout` if `agent[type]` is `service`. Will be one of `email`, `sms`, `website`, `web_trigger`, or `note` if `agent[type]` is `user`. See [below](https://developer.pagerduty.com/documentation/rest/log_entries/show#channel_types) for detailed information about channel formats. properties: type: type: string description: type user: type: object team: type: object notification: $ref: '#/components/schemas/Notification' channel: type: object description: channel required: - type ResolveReason: type: object properties: type: type: string description: The reason the incident was resolved. The only reason currently supported is merge. default: merge_resolve_reason enum: - merge_resolve_reason incident: $ref: '#/components/schemas/IncidentReference' LogEntryReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - acknowledge_log_entry_reference - annotate_log_entry_reference - assign_log_entry_reference - escalate_log_entry_reference - exhaust_escalation_path_log_entry_reference - notify_log_entry_reference - reach_trigger_limit_log_entry_reference - repeat_escalation_path_log_entry_reference - resolve_log_entry_reference - snooze_log_entry_reference - trigger_log_entry_reference - unacknowledge_log_entry_reference ResponderRequestTargetReference: type: object properties: type: type: string description: The type of target (either a user or an escalation policy) id: type: string description: The id of the user or escalation policy summary: type: string incident_responders: type: array description: An array of responders associated with the specified incident items: $ref: '#/components/schemas/IncidentsRespondersReference' NotificationSubscriber: title: NotificationSubscriber description: A reference of a subscriber entity. type: object properties: subscriber_id: type: string description: The ID of the entity being subscribed subscriber_type: type: string description: The type of the entity being subscribed enum: - user - team example: subscriber_id: PD1234 subscriber_type: user FlexibleTimeWindowIntelligentAlertGroupingConfig: type: object title: Intelligent Alert Grouping description: The configuration for Intelligent Alert Grouping. Note that this configuration is only available for certain plans. properties: time_window: type: integer minimum: 300 maximum: 3600 description: The maximum amount of time allowed between Alerts. Any Alerts arriving greater than `time_window` seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the "recommended_time_window," set the value to 0, otherwise the value must be between 300 and 3600. recommended_time_window: readOnly: true type: integer description: In order to ensure your Service has the optimal grouping window, we use data science to calculate your Service`s average Alert inter-arrival time. We encourage customer`s to use this value, please set `time_window` to 0 to use the `recommended_time_window`. AcknowledgerReference: allOf: - $ref: '#/components/schemas/Reference' - description: The acknowledger represents the entity that made the acknowledgement for an incident. type: object properties: type: enum: - user_reference - service_reference type: string Assignment: type: object properties: at: type: string format: date-time description: Time at which the assignment was created. assignee: oneOf: - $ref: '#/components/schemas/UserReference' - $ref: '#/components/schemas/User' required: - at - assignee ReachAckLimitLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - reach_ack_limit_log_entry IntegrationReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - aws_cloudwatch_inbound_integration_reference - cloudkick_inbound_integration_reference - event_transformer_api_inbound_integration_reference - generic_email_inbound_integration_reference - generic_events_api_inbound_integration_reference - keynote_inbound_integration_reference - nagios_inbound_integration_reference - pingdom_inbound_integration_reference - sql_monitor_inbound_integration_reference - events_api_v2_inbound_integration_reference - inbound_integration_reference TeamReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - team_reference AlertCount: type: object properties: triggered: type: integer description: The count of triggered alerts grouped into this incident resolved: type: integer description: The count of resolved alerts grouped into this incident all: type: integer description: The total count of alerts grouped into this incident ExhaustEscalationPathLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - exhaust_escalation_path_log_entry PriorityReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - priority_reference ConferenceBridge: type: object properties: conference_number: type: string description: The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input. conference_url: type: string format: url description: An URL for the conference bridge. This could be a link to a web conference or Slack channel. IncidentUrgencyRule: allOf: - $ref: '#/components/schemas/IncidentUrgencyType' - type: object properties: during_support_hours: $ref: '#/components/schemas/IncidentUrgencyType' outside_support_hours: $ref: '#/components/schemas/IncidentUrgencyType' User: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: name: type: string description: The name of the user. maxLength: 100 type: type: string description: The type of object being created. default: user enum: - user email: type: string format: email description: The user's email address. minLength: 6 maxLength: 100 time_zone: type: string format: tzinfo description: The preferred time zone name. If null, the account's time zone will be used. color: type: string description: The schedule color. role: description: The user role. Account must have the `read_only_users` ability to set a user as a `read_only_user` or a `read_only_limited_user`, and must have advanced permissions abilities to set a user as `observer` or `restricted_access`. type: string enum: - admin - limited_user - observer - owner - read_only_user - restricted_access - read_only_limited_user - user avatar_url: type: string format: url description: The URL of the user's avatar. readOnly: true description: type: string description: The user's bio. nullable: true invitation_sent: type: boolean readOnly: true description: If true, the user has an outstanding invitation. job_title: type: string description: The user's title. maxLength: 100 teams: type: array readOnly: true description: The list of teams to which the user belongs. Account must have the `teams` ability to set this. items: $ref: '#/components/schemas/TeamReference' contact_methods: type: array readOnly: true description: The list of contact methods for the user. items: $ref: '#/components/schemas/ContactMethodReference' notification_rules: readOnly: true type: array description: The list of notification rules for the user. items: $ref: '#/components/schemas/NotificationRuleReference' required: - name - email - type example: type: user name: Earline Greenholt email: 125.greenholt.earline@graham.name time_zone: America/Lima color: green role: admin job_title: Director of Engineering avatar_url: https://secure.gravatar.com/avatar/1d1a39d4635208d5664082a6c654a73f.png?d=mm&r=PG description: I'm the boss TimeBasedAlertGroupingConfiguration: type: object title: Time Grouping description: The configuration for Time Based Alert Grouping properties: timeout: type: integer description: The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0. LogEntry: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: type: type: string enum: - acknowledge_log_entry - annotate_log_entry - assign_log_entry - delegate_log_entry - escalate_log_entry - exhaust_escalation_path_log_entry - notify_log_entry - reach_ack_limit_log_entry - reach_trigger_limit_log_entry - repeat_escalation_path_log_entry - resolve_log_entry - snooze_log_entry - trigger_log_entry - unacknowledge_log_entry - urgency_change_log_entry created_at: type: string format: date-time readOnly: true description: Time at which the log entry was created. channel: $ref: '#/components/schemas/Channel' agent: $ref: '#/components/schemas/AgentReference' note: type: string readOnly: true description: Optional field containing a note, if one was included with the log entry. contexts: type: array readOnly: true description: Contexts to be included with the trigger such as links to graphs or images. items: $ref: '#/components/schemas/Context' service: $ref: '#/components/schemas/ServiceReference' incident: $ref: '#/components/schemas/IncidentReference' teams: type: array readOnly: true description: Will consist of references unless included items: $ref: '#/components/schemas/TeamReference' event_details: type: object readOnly: true properties: description: type: string description: Additional details about the event. UrgencyChangeLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - urgency_change_log_entry Alert: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: created_at: type: string format: date-time readOnly: true description: The date/time the alert was first triggered. type: type: string default: alert description: The type of object being created. enum: - alert status: type: string description: The current status of the alert. enum: - triggered - resolved alert_key: type: string readOnly: true description: The alert's de-duplication key. service: $ref: '#/components/schemas/ServiceReference' first_trigger_log_entry: $ref: '#/components/schemas/LogEntryReference' incident: $ref: '#/components/schemas/IncidentReference' suppressed: type: boolean readOnly: true description: Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident. default: false severity: type: string readOnly: true description: The magnitude of the problem as reported by the monitoring tool. enum: - info - warning - error - critical integration: $ref: '#/components/schemas/IntegrationReference' body: type: object readOnly: true description: A JSON object containing data describing the alert. title: Body properties: type: type: string description: The type of the body. enum: - alert_body contexts: type: array readOnly: true description: Contexts to be included with the body such as links to graphs or images. items: $ref: '#/components/schemas/Context' details: type: object readOnly: true description: An arbitrary JSON object or string containing any data explaining the nature of the alert. required: - type example: type: alert status: resolved incident: id: PEYSGVF type: incident_reference body: type: alert_body contexts: - type: link details: customKey: Server is on fire! customKey2: Other stuff! UnacknowledgeLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - unacknowledge_log_entry CustomFieldsEditableFieldValue: title: Custom Field Value oneOf: - type: object title: Value by Field Name properties: name: $ref: '#/components/schemas/CustomFieldsFieldValue/properties/name' value: oneOf: - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' - type: object title: Value by Field ID properties: id: type: string description: The ID of the Field. value: oneOf: - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/0' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/1' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/2' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/3' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/4' - $ref: '#/components/schemas/CustomFieldsFieldValue/properties/value/oneOf/5' UserReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - user_reference NotificationSubscriptionWithContext: title: NotificationSubscriptionWithContext type: object description: An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt. x-examples: example-1: subscriber_id: string subscriber_type: user subscribable_id: string subscribable_type: incident account_id: string result: success properties: subscriber_id: type: string description: The ID of the entity being subscribed subscriber_type: type: string enum: - user - team description: The type of the entity being subscribed subscribable_id: type: string description: The ID of the entity being subscribed to subscribable_type: type: string enum: - incident - business_service description: The type of the entity being subscribed to account_id: type: string description: The type of the entity being subscribed to result: type: string enum: - success - duplicate - unauthorized description: The resulting status of the subscription AcknowledgeLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: acknowledgement_timeout: type: integer description: Duration for which the acknowledgement lasts, in seconds. Services can contain an `acknowledgement_timeout` property, which specifies the length of time acknowledgements should last for. Each time an incident is acknowledged, this timeout is copied into the acknowledgement log entry. This property is optional, as older log entries may not contain it. It may also be `null`, as acknowledgements can be performed on incidents whose services have no `acknowledgement_timeout` set. type: type: string enum: - acknowledgement_log_entry CursorPagination: type: object properties: limit: type: integer description: The minimum of the `limit` parameter used in the request or the maximum request size of the API. readOnly: true next_cursor: type: string description: 'An opaque string than will deliver the next set of results when provided as the `cursor` parameter in a subsequent request. A `null` value for this field indicates that there are no additional results. ' example: dXNlcjaVMzc5V0ZYTlo= nullable: true readOnly: true required: - limit - next_cursor EscalationPolicy: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: type: type: string description: The type of object being created. default: escalation_policy enum: - escalation_policy name: type: string description: The name of the escalation policy. description: type: string description: Escalation policy description. num_loops: type: integer description: The number of times the escalation policy will repeat after reaching the end of its escalation. default: 0 minimum: 0 on_call_handoff_notifications: type: string description: Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". enum: - if_has_services - always escalation_rules: type: array items: $ref: '#/components/schemas/EscalationRule' services: type: array items: $ref: '#/components/schemas/ServiceReference' minLength: 0 readOnly: true teams: type: array description: Team associated with the policy. Account must have the `teams` ability to use this parameter. Only one team may be associated with the policy. items: $ref: '#/components/schemas/TeamReference' minLength: 0 required: - type - name - escalation_rules example: id: PQIL2IX type: escalation_policy name: Engineering Escalation Policy escalation_rules: - escalation_delay_in_minutes: 30 targets: - id: PEYSGVF type: user_reference escalation_rule_assignment_strategy: - type: round_robin services: - id: PIJ90N7 type: service_reference num_loops: 2 on_call_handoff_notifications: if_has_services teams: - id: PQ9K7I8 type: team_reference description: Here is the ep for the engineering team. Acknowledgement: type: object properties: at: type: string format: date-time description: Time at which the acknowledgement was created. acknowledger: oneOf: - $ref: '#/components/schemas/AcknowledgerReference' - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/Service' required: - at - acknowledger EscalationTargetReference: allOf: - $ref: '#/components/schemas/Reference' - type: object description: The escalation target is the entity that will be assigned an incident upon escalation. properties: type: enum: - user - schedule - user_reference - schedule_reference type: string RepeatEscalationPathLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - repeat_escalation_path_log_entry AgentReference: allOf: - $ref: '#/components/schemas/Reference' - type: object description: The agent (user, service or integration) that created or modified the Incident Log Entry. properties: type: enum: - user_reference - service_reference - integration_reference type: string readOnly: true AssignLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: assignees: type: array readOnly: true description: An array of assigned Users for this log entry items: $ref: '#/components/schemas/UserReference' type: type: string enum: - assign_log_entry TriggerLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - trigger_log_entry ResponderRequest: type: object properties: incident: $ref: '#/components/schemas/IncidentReference' requester: $ref: '#/components/schemas/UserReference' requested_at: type: string description: The time the request was made message: type: string description: The message sent with the responder request responder_request_targets: type: array description: The array of targets the responder request is being sent to items: $ref: '#/components/schemas/ResponderRequestTargetReference' StatusUpdate: type: object properties: id: type: string message: type: string description: The message of the status update. created_at: type: string description: The date/time when this status update was created. sender: $ref: '#/components/schemas/UserReference' subject: type: string description: The subject of the custom html email status update. Present if included in request body. html_message: type: string description: The html content of the custom html email status update. Present if included in request body. AnnotateLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: type: type: string enum: - annotate_log_entry AlertGroupingParameters: type: object description: 'Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null. ' properties: type: type: string nullable: true enum: - time - intelligent - content_based - null config: anyOf: - $ref: '#/components/schemas/FlexibleTimeWindowIntelligentAlertGroupingConfig' - $ref: '#/components/schemas/TimeBasedAlertGroupingConfiguration' - $ref: '#/components/schemas/ContentBasedAlertGroupingConfiguration' SupportHours: type: object properties: type: type: string description: The type of support hours default: fixed_time_per_day enum: - fixed_time_per_day time_zone: type: string format: activesupport-time-zone description: The time zone for the support hours days_of_week: type: array readOnly: true items: type: integer readOnly: true description: The days of the week (1 through 7, for Monday through Sunday) start_time: type: string format: time description: The support hours' starting time of day (date portion is ignored) end_time: type: string format: time description: The support hours' ending time of day (date portion is ignored) AddonReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: src: type: string format: url description: The URL source of the Addon name: type: string description: The user entered name of the Addon. type: type: string enum: - full_page_addon_reference - incident_show_addon_reference RelatedIncidentServiceDependencyBase: type: object properties: id: type: string description: The ID of the Service referenced. readOnly: true type: type: string description: The type of the related Service. enum: - business_service_reference - technical_service_reference self: type: string nullable: true readOnly: true format: url description: The API show URL at which the object is accessible. AutoPauseNotificationsParameters: title: AutoPauseNotificationsParameters type: object description: Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans. properties: enabled: type: boolean default: false description: Indicates whether alerts should be automatically suspended when identified as transient timeout: type: integer enum: - 120 - 180 - 300 - 600 - 900 description: Indicates in seconds how long alerts should be suspended before triggering example: enabled: true timeout: 300 ScheduledAction: type: object properties: type: type: string description: The type of schedule action. Must be set to urgency_change. enum: - urgency_change at: type: object description: Represents when scheduled action will occur. properties: type: type: string description: Must be set to named_time. enum: - named_time name: type: string description: Designates either the start or the end of support hours. enum: - support_hours_start - support_hours_end required: - type - name to_urgency: type: string description: Urgency level. Must be set to high. enum: - high required: - type - at - to_urgency IncidentsRespondersReference: type: object properties: state: type: string description: The status of the responder being added to the incident example: pending user: $ref: '#/components/schemas/UserReference' incident: $ref: '#/components/schemas/IncidentReference' updated_at: type: string message: type: string description: The message sent with the responder request requester: $ref: '#/components/schemas/UserReference' requested_at: type: string RelatedIncidentMachineLearningRelationship: type: object description: 'The data for a type of relationship where the Incident is related due to our machine learning algorithm. ' properties: grouping_classification: type: string description: 'The classification for why this Related Incident was grouped into this group. Values can be one of: [similar_contents, prior_feedback], where: similar_contents - The Related Incident was due to similar contents of the Incidents. prior_feedback - The Related Incident was determined to be related, based on User feedback or Incident merge/unmerge actions. ' enum: - similar_contents - prior_feedback user_feedback: type: object description: The feedback provided from Users to influence the machine learning algorithm for future Related Incidents. properties: positive_feedback_count: type: integer description: The total number of times Users agreed that the Incidents are related. negative_feedback_count: type: integer description: The total number of times Users disagreed that the Incidents are related. DelegateLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: assignees: type: array readOnly: true description: An array of assigned Users for this log entry items: $ref: '#/components/schemas/UserReference' type: type: string enum: - delegate_log_entry Incident: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object properties: incident_number: type: integer readOnly: true description: The number of the incident. This is unique across your account. title: type: string readOnly: false description: A succinct description of the nature, symptoms, cause, or effect of the incident. created_at: type: string format: date-time description: The time the incident was first triggered. example: '2019-12-01T20:00:00Z' readOnly: true updated_at: type: string format: date-time example: '2019-12-01T21:02:00Z' description: The time the incident was last modified. status: type: string description: The current status of the incident. enum: - triggered - acknowledged - resolved incident_key: type: string readOnly: true description: The incident's de-duplication key. service: description: The service the incident is on. If the `include[]=services` query parameter is provided, the full service definition will be returned. oneOf: - $ref: '#/components/schemas/ServiceReference' - $ref: '#/components/schemas/Service' assignments: type: array description: List of all assignments for this incident. This list will be empty if the `Incident.status` is `resolved`. Returns a user reference for each assignment. Full user definitions will be returned if the `include[]=assignees` query parameter is provided. items: $ref: '#/components/schemas/Assignment' assigned_via: type: string description: How the current incident assignments were decided. Note that `direct_assignment` incidents will not escalate up the attached `escalation_policy` enum: - escalation_policy - direct_assignment readOnly: true last_status_change_at: type: string format: date-time description: The time the status of the incident last changed. If the incident is not currently acknowledged or resolved, this will be the incident's `updated_at`. example: '2019-12-01T21:01:00Z' readOnly: true resolved_at: type: string format: date-time example: '2019-12-01T21:01:00Z' description: The time the incident became "resolved" or `null` if the incident is not resolved. first_trigger_log_entry: description: The first log entry on the incident. The log entry will be of type `TriggerLogEntry` and will represent information about how the incident was triggered. If the `include[]=first_trigger_log_entries` query parameter is provided, the full log entry definition will be returned. oneOf: - $ref: '#/components/schemas/LogEntryReference' - $ref: '#/components/schemas/TriggerLogEntry' alert_counts: $ref: '#/components/schemas/AlertCount' is_mergeable: type: boolean description: Whether the incident is mergeable. Only incidents that have alerts, or that are manually created can be merged. readOnly: true escalation_policy: description: The escalation policy attached to the service that the incident is on. If the `include[]=escalation_policies` query parameter is provided, the full escalation policy definition will be returned. oneOf: - $ref: '#/components/schemas/EscalationPolicyReference' - $ref: '#/components/schemas/EscalationPolicy' teams: type: array description: The teams involved in the incident’s lifecycle. If the `include[]=teams` query parameter is provided, the full team definitions will be returned. items: oneOf: - $ref: '#/components/schemas/TeamReference' - $ref: '#/components/schemas/Team' pending_actions: type: array readOnly: true description: The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to. items: $ref: '#/components/schemas/IncidentAction' acknowledgements: type: array description: List of all acknowledgements for this incident. This list will be empty if the `Incident.status` is `resolved` or `triggered`. If the `include[]=acknowledgers` query parameter is provided, the full user or service definitions will be returned for each acknowledgement entry. items: $ref: '#/components/schemas/Acknowledgement' alert_grouping: description: Describes the alert grouping state of this incident. Will be null if the incident has no alerts. type: object properties: grouping_type: type: string enum: - basic - advanced - rules started_at: type: string format: date-time ended_at: type: string format: date-time alert_grouping_active: type: boolean last_status_change_by: description: The entity that last changed the status of the incident. If the `include[]=agents` query parameter is provided, the full user/service/integration definition will be returned. oneOf: - $ref: '#/components/schemas/AgentReference' - $ref: '#/components/schemas/User' - $ref: '#/components/schemas/Service' priority: $ref: '#/components/schemas/Priority' resolve_reason: $ref: '#/components/schemas/ResolveReason' conference_bridge: description: The conference bridge information attached to the incident. Only returned if the `include[]=conference_bridge` query parameter is provided. allOf: - $ref: '#/components/schemas/ConferenceBridge' incidents_responders: description: The responders on the incident. Only returned if the account has access to the [responder requests](https://support.pagerduty.com/docs/add-responders) feature. type: array readOnly: true items: $ref: '#/components/schemas/IncidentsRespondersReference' responder_requests: description: Previous responder requests made on this incident. Only returned if the account has access to the [responder requests](https://support.pagerduty.com/docs/add-responders) feature. type: array readOnly: true items: $ref: '#/components/schemas/ResponderRequest' urgency: type: string enum: - high - low description: The current urgency of the incident. body: description: The additional incident body details. Only returned if the `include[]=body` query parameter is provided. allOf: - $ref: '#/components/schemas/IncidentBody' IncidentUrgencyType: type: object properties: type: type: string description: 'The type of incident urgency: whether it''s constant, or it''s dependent on the support hours.' default: constant enum: - constant - use_support_hours urgency: type: string description: The incidents' urgency, if type is constant. default: high enum: - low - high - severity_based ContactMethodReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - email_contact_method_reference - phone_contact_method_reference - push_notification_contact_method_reference - sms_contact_method_reference NotificationSubscriberWithContext: title: NotificationSubscriberWithContext description: A reference of a subscriber entity with additional subscription context. type: object example: subscriber_id: PD1234 subscriber_type: user properties: subscriber_id: type: string description: The ID of the entity being subscribed subscriber_type: type: string description: The type of the entity being subscribed enum: - user - team has_indirect_subscription: type: boolean description: If this subcriber has an indirect subscription to this incident via another object subscribed_via: nullable: true type: array items: type: object properties: id: type: string description: The id of the object this subscriber is subscribed via name: type: string description: The type of the object this subscriber is subscribed via RelatedIncidentServiceDependencyRelationship: type: object description: 'The data for a type of relationship where the Incident is related due to Business or Technical Service dependencies. Both `dependent_services` and `supporting_services` are returned to signify the dependencies between the Services that the Incident and Related Incident belong to. Each Service reference returned in the list of supporting and dependent Services has a type of: [business_service_reference, technical_service_reference]. ' properties: dependent_services: type: array items: $ref: '#/components/schemas/RelatedIncidentServiceDependencyBase' supporting_services: type: array items: $ref: '#/components/schemas/RelatedIncidentServiceDependencyBase' Reference: allOf: - $ref: '#/components/schemas/Tag/allOf/0' - type: object required: - type - id EscalateLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: assignees: type: array readOnly: true description: An array of assigned Users for this log entry items: $ref: '#/components/schemas/UserReference' type: type: string enum: - escalate_log_entry ServiceReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - service_reference SnoozeLogEntry: allOf: - $ref: '#/components/schemas/LogEntry' - type: object properties: changed_actions: type: array items: $ref: '#/components/schemas/IncidentAction' type: type: string enum: - snooze_log_entry EscalationPolicyReference: allOf: - $ref: '#/components/schemas/Reference' - type: object properties: type: type: string enum: - escalation_policy_reference IncidentAction: description: An incident action is a pending change to an incident that will automatically happen at some future time. type: object properties: type: type: string enum: - unacknowledge - escalate - resolve - urgency_change at: type: string format: date-time to: description: The urgency that the incident will change to. This field is only present when the type is `urgency_change`. type: string enum: - high discriminator: propertyName: type required: - type - at Pagination: type: object properties: offset: type: integer description: Echoes offset pagination property. readOnly: true limit: type: integer description: Echoes limit pagination property. readOnly: true more: type: boolean description: Indicates if there are additional records to return readOnly: true total: type: integer description: The total number of records matching the given query. nullable: true readOnly: true Tag: allOf: - type: object properties: id: type: string readOnly: true summary: type: string nullable: true readOnly: true description: A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to `name`, though it is not intended to be an identifier. type: type: string readOnly: true description: A string that determines the schema of the object. This must be the standard name for the entity, suffixed by `_reference` if the object is a reference. self: type: string nullable: true readOnly: true format: url description: the API show URL at which the object is accessible html_url: type: string nullable: true readOnly: true format: url description: a URL at which the entity is uniquely displayed in the Web app - type: object properties: type: type: string description: The type of object being created. default: tag enum: - tag label: type: string description: The label of the tag. maxLength: 191 required: - label - type example: type: tag label: Batman responses: Forbidden: description: 'Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action. ' content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' UnprocessableEntity: description: Unprocessable Entity. Some arguments failed validation checks. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' NotFound: description: The requested resource was not found. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' RequestEntityTooLarge: description: Caller provided a request that is too large to process. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' PaymentRequired: description: 'Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account. ' content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' ArgumentError: description: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' TooManyRequests: description: Too many requests have been made, the rate limit has been reached. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' InternalServerError: description: Internal Server Error the PagerDuty server experienced an error. content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' Unauthorized: description: 'Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed. ' content: application/json: schema: $ref: '#/components/responses/Conflict/content/application~1json/schema' Conflict: description: The request conflicts with the current state of the server. content: application/json: schema: type: object properties: error: type: object properties: code: type: integer readOnly: true message: type: string readOnly: true description: Error message string errors: type: array readOnly: true items: type: string readOnly: true description: Human-readable error details example: message: Not Found code: 2100 securitySchemes: api_key: type: apiKey name: Authorization in: header description: The API Key with format `Token token=`