add_escalation_policy_to_team
Add an escalation policy to a team.
Parameters
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
add_subscribers_to_incident
Subscribe the given entities to Incident Status Update Notifications.
Parameters
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"
} ]
}
add_user_to_team
Add a user to a team. Attempting to add a user with the read_only_user role will return a 400 error.
Parameters
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
create_addon
Install an add-on for your account.
Parameters
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."
}
}
create_contact_method_for_user
Create a new contact method.
Parameters
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."
}
}
create_escalation_policy
Creates a new escalation policy. There must be at least one existing escalation rule added to create a new escalation policy.
Parameters
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
create_extension
Create a new extension.
Parameters
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."
}
}
create_incident
Create an incident synchronously without a corresponding event from a monitoring service.
Parameters
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."
}
}
}
create_integration_for_service
Create a new integration belonging to a service.
Parameters
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."
}
}
create_maintenance_window
Create a new maintenance window for the specified services. No new incidents will be created for a service that is in maintenance.
Parameters
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."
}
}
create_note_for_incident
Create a new note for the specified incident.
Parameters
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"
}
}
create_notification_rule_for_user
Create a new notification rule.
Parameters
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."
}
}
create_override_for_schedule
Create an override for a specific user covering the specified time range. If you create an override on top of an existing one, the last created override will have priority.
Parameters
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."
}
}
}
create_schedule
Create a new on-call schedule.
Parameters
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=trueparameter, you will get one schedule entry returned with a start of2011-06-01T10:00:00Zand end of2011-06-01T14:00:00Z. - If you do pass the
overflow=trueparameter, you will get one schedule entry returned with a start of2011-06-01T00:00:00Zand end of2011-06-02T00:00:00Z.
Type: boolean
create_service
Create a new service.
Parameters
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."
}
}
create_status_update_for_incident
Create a new status update for the specified incident.
Parameters
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."
}
create_team
Create a new team.
Parameters
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."
}
}
create_user
Create a new user. Note that you must also supply a password property to create a user--it will not be returned by any API.
Parameters
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."
}
}
delete_addon
Remove an existing add-on.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
addon_id (required)
The add-on ID.
Type: string
delete_contact_method_for_user
Remove a user's contact method.
Parameters
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
delete_escalation_policy
Deletes an existing escalation policy and rules. The escalation policy must not be in use by any services.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
escalation_id (required)
The escalation ID.
Type: string
delete_escalation_policy_from_team
Remove an escalation policy from a team.
Parameters
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
delete_extension
Delete an existing extension. Once the extension is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this extension.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
extension_id (required)
The extension ID.
Type: string
delete_maintenance_window
Delete an existing maintenance window if it's in the future, or end it if it's currently on-going. If the maintenance window has already ended it cannot be deleted.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
maintenance_window_id (required)
The maintenance window ID.
Type: string
delete_notification_rule_for_user
Remove a user's notification rule.
Parameters
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
delete_schedule
Delete an on-call schedule.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
schedule_id (required)
The schedule ID.
Type: string
delete_schedule_override
Remove an override. You cannot remove a past override. If the override start time is before the current time, but the end time is after the current time, the override will be truncated to the current time. If the override is truncated, the status code will be 200 OK, as opposed to a 204 No Content for a successful delete.
Parameters
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
delete_service
Delete an existing service. Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
service_id (required)
The service ID.
Type: string
delete_team
Remove an existing team.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
team_id (required)
The team ID.
Type: string
delete_user
Remove an existing user.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
user_id (required)
The user ID.
Type: string
delete_user_from_team
Remove a user from a team.
Parameters
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
get_ability
Test whether your account has a given ability.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
ability_id (required)
The ability ID.
Type: string
get_addon
Get details about an existing add-on.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
addon_id (required)
The add-on ID.
Type: string
get_alert_for_incident
Show detailed information about an alert. Accepts an alert id.
Parameters
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
get_api_reference
This operation has no parameters
get_business_service_dependencies
Get all immediate dependencies of any business service.
Business services model capabilities that span multiple technical services and that may be owned by several different teams.
For more information see the API Concepts Document
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
service_id (required)
The service ID.
Type: string
get_contact_method_for_user
Get details about a user's contact method.
Parameters
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
get_current_user
Get the current user.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
get_escalation_policy
Get information about an existing escalation policy and its rules.
Parameters
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" ]
get_extension
Get details about an existing extension.
Parameters
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" ]
get_extension_schema
Get details about one specific extension vendor.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
extension_schema_id (required)
The extension schema ID.
Type: string
get_incident
Show detailed information about an incident. Accepts either an incident id, or an incident number.
Parameters
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" ]
get_integration_for_service
Get details about an integration belonging to a service.
Parameters
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" ]
get_log_entry
Get details for a specific incident log entry. This method provides additional information you can use to get at raw event data.
Parameters
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
get_maintenance_window
Get an existing maintenance window.
Parameters
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" ]
get_notification_rule_for_user
Get details about a user's notification rule.
Parameters
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" ]
get_schedule
Show detailed information about a schedule, including entries for each layer and sub-schedule.
Parameters
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
get_service
Get details about an existing service.
Parameters
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" ]
get_team
Get details about an existing team.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
team_id (required)
The team ID.
Type: string
get_technical_service_dependencies
Get all immediate dependencies of any technical service. Technical services are also known as services.
For more information see the API Concepts Document
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
service_id (required)
The service ID.
Type: string
get_user
Get details about an existing user.
Parameters
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" ]
get_vendors_by_id
Get details about one specific vendor.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
vendor_id (required)
The vendor ID.
Type: string
list_abilities
This operation has no parameters
list_addons
List all of the add-ons installed on your account.
Parameters
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" ]
list_alerts_for_incident
List alerts for the specified incident.
Parameters
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" ]
list_business_service_subscribers
List business services subscribers
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
X-EARLY-ACCESS (required)
Type: string
service_id (required)
The service ID.
Type: string
list_business_services
List existing business services.
Business services model capabilities that span multiple technical services and that may be owned by several different teams.
For more information see the API Concepts Document
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
list_contact_methods_for_user
List contact methods of your PagerDuty user.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
user_id (required)
The user ID.
Type: string
list_escalation_policies
List all of the existing escalation policies.
Parameters
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" ]
list_extension_schemas
List all extension schemas.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
list_extensions
List existing extensions.
Parameters
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
list_incidents
List existing incidents.
Parameters
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" ]
list_log_entries
List all of the incident log entries across the entire account.
Parameters
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
list_log_entries_for_incident
List log entries for the specified incident.
Parameters
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
list_maintenance_windows
List existing maintenance windows, optionally filtered by service and/or team, or whether they are from the past, present or future.
Parameters
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" ]
list_notes_for_incident
List existing notes for the specified incident.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
incident_id (required)
The incident ID.
Type: string
list_notification_rules_for_user
List notification rules of your PagerDuty user.
Parameters
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" ]
list_notifications
List notifications for a given time range, optionally filtered by type (sms_notification, email_notification, phone_notification, or push_notification).
Parameters
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
list_oncalls
List the on-call entries during a given time range.
Parameters
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" ]
list_overrides_for_schedule
List overrides for a given time range.
Parameters
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
list_priorities
List existing priorities, in order (most to least severe).
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
list_response_plays
List all of the existing Response Plays.
Response Plays allow you to create packages of Incident Actions that can be applied during an Incident's life cycle.
For more information see the API Concepts Document
Parameters
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
list_schedules
List the on-call schedules.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
query
Filters the result, showing only the schedules whose name matches the query.
Type: string
list_services
List existing services.
Parameters
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
list_teams
List teams of your PagerDuty account, optionally filtered by a search query.
Parameters
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
list_users
List users of your PagerDuty account, optionally filtered by a search query.
Parameters
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" ]
list_users_for_schedule
List all of the users on call in a given schedule for a given time range.
Parameters
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
list_vendors
List all vendors.
Parameters
Accept (required)
Accept header needed for Oauth2
Type: string
manage_alerts_for_incident
Resolve multiple alerts or associate them with different incidents.
Parameters
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."
} ]
}
manage_incidents
Acknowledge, resolve, escalate or reassign one or more incidents.
Parameters
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."
} ]
}
merge_incidents
Merge a list of source incidents into this incident.
Parameters
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."
} ]
}
preview_schedule
Preview what an on-call schedule would look like without saving it.
Parameters
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=trueparameter, you will get one schedule entry returned with a start of2011-06-01T10:00:00Zand end of2011-06-01T14:00:00Z. - If you do pass the
overflow=trueparameter, you will get one schedule entry returned with a start of2011-06-01T00:00:00Zand end of2011-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
run_response_play
Run a specified response play on a given incident.
Response Plays are a package of Incident Actions that can be applied during an Incident's life cycle.
For more information see the API Concepts Document
Parameters
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."
}
}
send_responder_request_for_incident
Send a new responder request for the specified incident.
Parameters
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"
}
snooze_incident
Snooze an incident.
Parameters
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."
}
update_addon
Update an existing add-on.
Parameters
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."
}
}
update_alert_for_incident
Resolve an alert or associate an alert with a new parent incident.
Parameters
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."
}
}
update_contact_method_for_user
Update a user's contact method.
Parameters
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."
}
}
update_escalation_policy
Updates an existing escalation policy and rules.
Parameters
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."
}
}
update_extension
Update an existing extension.
Parameters
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."
}
}
update_incident
Acknowledge, resolve, escalate or reassign an incident.
Parameters
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."
}
}
update_integration_for_service
Update an integration belonging to a service.
Parameters
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."
}
}
update_maintenance_window
Update an existing maintenance window.
Parameters
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."
}
}
update_notification_rule_for_user
Update a user's notification rule.
Parameters
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."
}
}
update_schedule
Update an existing on-call schedule.
Parameters
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=trueparameter, you will get one schedule entry returned with a start of2011-06-01T10:00:00Zand end of2011-06-01T14:00:00Z. - If you do pass the
overflow=trueparameter, you will get one schedule entry returned with a start of2011-06-01T00:00:00Zand end of2011-06-02T00:00:00Z.
Type: boolean
update_service
Update an existing service.
Parameters
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."
}
}
update_team
Update an existing team.
Parameters
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."
}
}
update_user
Update an existing user. Note that you may also supply a password property--it will not be returned by any API.
Parameters
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."
}
}