PagerDuty (version v3.*.*)

Accept (required)#

Accept header needed for Oauth2

Type: string

escalation_policy_id (required)#

The escalation policy ID on the team.

Type: string

team_id (required)#

The team ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

X-EARLY-ACCESS (required)#

Type: string

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "subscribers" : [ {
    "subscriber_id" : "The ID of the entity being subscribed",
    "subscriber_type" : "The type of the entity being subscribed"
  } ]
}

Accept (required)#

Accept header needed for Oauth2

Type: string

team_id (required)#

The team ID.

Type: string

user_id (required)#

The user ID on the team.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The add-on to be installed.

Type: object

{
  "addon" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

$body#

The contact method to be created.

Type: object

{
  "contact_method" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The escalation policy to be created.

Type: object

{
  "escalation_policy" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

From#

The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.

Type: email

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The extension to be created

Type: object

{
  "extension" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

$body#

Type: object

{
  "incident" : {
    "conference_bridge" : {
      "conference_url" : "A URL for the conference bridge.",
      "conference_number" : "The phone number of the conference call for the conference bridge."
    },
    "assignments" : [ {
      "assignee" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      }
    } ],
    "urgency" : "The urgency of the incident",
    "service" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "incident_key" : "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.",
    "type" : "Required string. Possible values: incident",
    "title" : "A succinct description of the nature, symptoms, cause, or effect of the incident.",
    "priority" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "body" : {
      "details" : "Additional incident details.",
      "type" : "Required string. Possible values: incident_body"
    },
    "escalation_policy" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    }
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

$body#

The integration to be created

Type: object

{
  "integration" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

$body#

The maintenance window object.

Type: object

{
  "maintenance_window" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "note" : {
    "created_at" : "The time at which the note was submitted",
    "id" : "string",
    "user" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "content" : "The note content"
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

$body#

The notification rule to be created.

Type: object

{
  "notification_rule" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

$body#

The override to be created

Type: object

{
  "override" : {
    "start" : "The start date and time for the override.",
    "end" : "The end date and time for the override.",
    "id" : "string",
    "user" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    }
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The schedule to be created.

Type: object

{
  "schedule" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

overflow#

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.
For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:

• If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z.
• If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Type: boolean

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The service to be created

Type: object

{
  "service" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "message" : "The message to be posted as a status update."
}

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The team to be created.

Type: object

{
  "team" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

$body#

The user to be created.

Type: object

{
  "user" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

addon_id (required)#

The add-on ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

contact_method_id (required)#

The contact method ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

escalation_id (required)#

The escalation ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

escalation_policy_id (required)#

The escalation policy ID on the team.

Type: string

team_id (required)#

The team ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

extension_id (required)#

The extension ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

maintenance_window_id (required)#

The maintenance window ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

notification_rule_id (required)#

The notification rule ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

override_id (required)#

The override ID on the schedule.

Type: string

schedule_id (required)#

The schedule ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

team_id (required)#

The team ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

team_id (required)#

The team ID.

Type: string

user_id (required)#

The user ID on the team.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

ability_id (required)#

The ability ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

addon_id (required)#

The add-on ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

alert_id (required)#

The id of the alert to retrieve.

Type: string

incident_id (required)#

The incident ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

contact_method_id (required)#

The contact method ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

escalation_id (required)#

The escalation ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

extension_id (required)#

The extension ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

extension_schema_id (required)#

The extension schema ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

incident_id (required)#

The incident ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

integration_id (required)#

The integration ID on the service.

Type: string

service_id (required)#

The service ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

log_entry_id (required)#

The log entry ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

Accept (required)#

Accept header needed for Oauth2

Type: string

maintenance_window_id (required)#

The maintenance window ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

notification_rule_id (required)#

The notification rule ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

since#

The start of the date range over which you want to search.

Type: date-time

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

until#

The end of the date range over which you want to search.

Type: date-time

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

team_id (required)#

The team ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

vendor_id (required)#

The vendor ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

filter#

Filters the results, showing only add-ons of the given type

Type: string

Potential values: full_page_addon, incident_show_addon

include[]#

Array of additional details to include.

Type: array

[ "string" ]

service_ids[]#

Filters the results, showing only add-ons for the given services

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

incident_id (required)#

The incident ID.

Type: string

alert_key#

Alert de-duplication key.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string. Possible values: services | first_trigger_log_entries | incidents" ]

sort_by#

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.

Type: array

[ "string. Possible values: created_at | resolved_at | created_at:asc | created_at:desc | resolved_at:asc | resolved_at:desc" ]

statuses[]#

Return only alerts with the given statuses. (More status codes may be introduced in the future.)

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

X-EARLY-ACCESS (required)#

Type: string

service_id (required)#

The service ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

query#

Filters the results, showing only the escalation policies whose names contain the query.

Type: string

sort_by#

Used to specify the field you wish to sort the results on.

Type: string

Potential values: name, name:asc, name:desc

team_ids[]#

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Type: array

[ "string" ]

user_ids[]#

Filters the results, showing only escalation policies on which any of the users is a target.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

extension_object_id#

The id of the extension object you want to filter by.

Type: string

extension_schema_id#

Filter the extensions by extension vendor id.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

query#

Filters the result, showing only the extensions whose name matches the query.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

date_range#

When set to all, the since and until parameters and defaults are ignored.

Type: string

Potential values: all

incident_key#

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.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

service_ids[]#

Returns only the incidents associated with the passed service(s). This expects one or more service IDs.

Type: array

[ "string" ]

since#

The start of the date range over which you want to search.

Type: date-time

sort_by#

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.

Type: array

[ "string" ]

statuses[]#

Return only incidents with the given statuses. (More status codes may be introduced in the future.)

Type: array

[ "string" ]

team_ids[]#

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Type: array

[ "string" ]

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

until#

The end of the date range over which you want to search.

Type: date-time

urgencies[]#

Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this.

Type: array

[ "string" ]

user_ids[]#

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.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

is_overview#

If true, will return a subset of log entries that show only the most important changes to the incident.

Type: boolean

since#

The start of the date range over which you want to search.

Type: date-time

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

until#

The end of the date range over which you want to search.

Type: date-time

Accept (required)#

Accept header needed for Oauth2

Type: string

incident_id (required)#

The incident ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

is_overview#

If true, will return a subset of log entries that show only the most important changes to the incident.

Type: boolean

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

Accept (required)#

Accept header needed for Oauth2

Type: string

filter#

Only return maintenance windows in a given state.

Type: string

Potential values: past, future, ongoing, open, all

include[]#

Array of additional details to include.

Type: array

[ "string" ]

query#

Filters the results, showing only the maintenance windows whose descriptions contain the query.

Type: string

service_ids[]#

An array of service IDs. Only results related to these services will be returned.

Type: array

[ "string" ]

team_ids[]#

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

incident_id (required)#

The incident ID.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

since (required)#

The start of the date range over which you want to search. The time element is optional.

Type: date-time

until (required)#

The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months.

Type: date-time

filter#

Return notification of this type only.

Type: string

Potential values: sms_notification, email_notification, phone_notification, push_notification

include[]#

Array of additional details to include.

Type: array

[ "string" ]

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

Accept (required)#

Accept header needed for Oauth2

Type: string

earliest#

This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.

Type: boolean

escalation_policy_ids[]#

Filters the results, showing only on-calls for the specified escalation policy IDs.

Type: array

[ "string" ]

include[]#

Array of additional details to include.

Type: array

[ "string" ]

schedule_ids[]#

Filters the results, showing only on-calls for the specified schedule IDs. If null is provided in the array, it includes permanent on-calls due to direct user escalation targets.

Type: array

[ "string" ]

since#

The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. The search range cannot exceed 3 months.

Type: date-time

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

until#

The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. The search range cannot exceed 3 months, and the until time cannot be before the since time.

Type: date-time

user_ids[]#

Filters the results, showing only on-calls for the specified user IDs.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

since (required)#

The start of the date range over which you want to search.

Type: date-time

until (required)#

The end of the date range over which you want to search.

Type: date-time

editable#

When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.

Type: boolean

overflow#

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.

Type: boolean

Accept (required)#

Accept header needed for Oauth2

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

filter_for_manual_run#

When this parameter is present, only those Response Plays that can be run manually will be returned.

Type: boolean

query#

Filters the result, showing only the tags whose labels match the query.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

query#

Filters the result, showing only the schedules whose name matches the query.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

query#

Filters the result, showing only the services whose name or service_key matches the query.

Type: string

sort_by#

Used to specify the field you wish to sort the results on.

Type: string

Potential values: name, name:asc, name:desc

team_ids[]#

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Type: array

[ "string" ]

time_zone#

Time zone in which dates in the result will be rendered.

Type: tzinfo

Accept (required)#

Accept header needed for Oauth2

Type: string

query#

Filters the result, showing only the teams whose names or email addresses match the query.

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

include[]#

Array of additional details to include.

Type: array

[ "string" ]

query#

Filters the result, showing only the users whose names or email addresses match the query.

Type: string

team_ids[]#

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Type: array

[ "string" ]

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

since#

The start of the date range over which you want to search.

Type: date-time

until#

The end of the date range over which you want to search.

Type: date-time

Accept (required)#

Accept header needed for Oauth2

Type: string

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "alerts" : [ {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  } ]
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

$body#

Type: object

{
  "incidents" : [ {
    "assignments" : [ {
      "assignee" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      }
    } ],
    "id" : "The id of the incident to update.",
    "type" : "The incident type.",
    "title" : "A succinct description of the nature, symptoms, cause, or effect of the incident.",
    "priority" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "escalation_policy" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "resolution" : "The resolution for this incident if status is set to resolved.",
    "escalation_level" : "Escalate the incident to this level in the escalation policy.",
    "status" : "The new status of the incident."
  } ]
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "source_incidents" : [ {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  } ]
}

Accept (required)#

Accept header needed for Oauth2

Type: string

$body#

The schedule to be previewed.

Type: object

{
  "schedule" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

overflow#

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.
For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:

• If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z.
• If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Type: boolean

since#

The start of the date range over which you want to search.

Type: date-time

until#

The end of the date range over which you want to search.

Type: date-time

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

response_play_id (required)#

The response play ID of the response play associated with the request.

Type: string

$body#

Type: object

{
  "incident" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "responder_request_targets" : [ {
    "summary" : "string",
    "id" : "The id of the user or escalation policy",
    "type" : "The type of target (either a user or an escalation policy)",
    "incident_responders" : [ {
      "requester" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      },
      "state" : "string",
      "user" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      },
      "incident" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      },
      "requested_at" : "string"
    } ]
  } ],
  "message" : "The message sent with the responder request",
  "requester_id" : "The user id of the requester"
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "duration" : "The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the \"triggered\" state."
}

Accept (required)#

Accept header needed for Oauth2

Type: string

addon_id (required)#

The add-on ID.

Type: string

$body#

The add-on to be updated.

Type: object

{
  "addon" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

alert_id (required)#

The id of the alert to retrieve.

Type: string

incident_id (required)#

The incident ID.

Type: string

$body#

The parameters of the alert to update.

Type: object

{
  "alert" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

contact_method_id (required)#

The contact method ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

$body#

The user's contact method to be updated.

Type: object

{
  "contact_method" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

escalation_id (required)#

The escalation ID.

Type: string

$body#

The escalation policy to be updated.

Type: object

{
  "escalation_policy" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

extension_id (required)#

The extension ID.

Type: string

$body#

The extension to be updated.

Type: object

{
  "extension" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

From (required)#

The email address of a valid user associated with the account making the request.

Type: email

incident_id (required)#

The incident ID.

Type: string

$body#

Type: object

{
  "incident" : {
    "assignments" : [ {
      "assignee" : {
        "summary" : "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.",
        "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
        "self" : "the API show URL at which the object is accessible",
        "id" : "string",
        "type" : "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."
      }
    } ],
    "urgency" : "The urgency of the incident.",
    "type" : "The incident type.",
    "priority" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "title" : "The new title of the incident.",
    "escalation_policy" : {
      "summary" : "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.",
      "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
      "self" : "the API show URL at which the object is accessible",
      "id" : "string",
      "type" : "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."
    },
    "resolution" : "The resolution for this incident if status is set to resolved.",
    "escalation_level" : "Escalate the incident to this level in the escalation policy.",
    "status" : "The new status of the incident."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

integration_id (required)#

The integration ID on the service.

Type: string

service_id (required)#

The service ID.

Type: string

$body#

The integration to be updated

Type: object

{
  "integration" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

maintenance_window_id (required)#

The maintenance window ID.

Type: string

$body#

The maintenance window to be updated.

Type: object

{
  "maintenance_window" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

notification_rule_id (required)#

The notification rule ID on the user.

Type: string

user_id (required)#

The user ID.

Type: string

$body#

The user's notification rule to be updated.

Type: object

{
  "notification_rule" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

schedule_id (required)#

The schedule ID.

Type: string

$body#

The schedule to be updated.

Type: object

{
  "schedule" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

overflow#

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.
For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z:

• If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z.
• If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Type: boolean

Accept (required)#

Accept header needed for Oauth2

Type: string

service_id (required)#

The service ID.

Type: string

$body#

The service to be updated.

Type: object

{
  "service" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

team_id (required)#

The team ID.

Type: string

$body#

The team to be updated.

Type: object

{
  "team" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}

Accept (required)#

Accept header needed for Oauth2

Type: string

user_id (required)#

The user ID.

Type: string

$body#

The user to be updated.

Type: object

{
  "user" : {
    "summary" : "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.",
    "html_url" : "a URL at which the entity is uniquely displayed in the Web app",
    "self" : "the API show URL at which the object is accessible",
    "id" : "string",
    "type" : "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."
  }
}