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.
schedule
object
Yes
—
The schedule value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "overflow": { "type": "boolean", "description": "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`." }, "schedule": { "description": "The schedule value" } }, "required": [ "PCID", "schedule" ]}
Request schema for creating/updating a given Status Page Post resource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "post": { "type": "object", "description": "Request schema for creating/updating a given Status Page Post resource.", "properties": { "type": { "type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post." }, "title": { "type": "string", "description": "The title given to a Post." }, "post_type": { "type": "string", "description": "The type of the Post." }, "starts_at": { "type": "string", "description": "The date and time the Post intent becomes effective - only for maintenance post type." }, "ends_at": { "type": "string", "description": "The date and time the Post intent is concluded - only for maintenance post type." }, "updates": { "type": "array", "description": "Post Updates to be associated with a Post" }, "status_page": { "type": "object", "description": "Status Page" } }, "required": [ "type", "title", "post_type", "starts_at", "ends_at", "updates", "status_page" ] } }, "required": [ "PCID", "id", "post" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "post_id": { "type": "string", "description": "The ID of the Status Page Post." }, "post_update": { "type": "object", "description": "Attributes for Post Update creation/update", "properties": { "self": { "type": "string", "description": "The path to which the Post Update resource is accessible." }, "post": { "type": "object", "description": "Status Page Post" }, "message": { "type": "string", "description": "The message of the Post Update." }, "status": { "type": "object", "description": "Status Page Status" }, "severity": { "type": "object", "description": "Status Page Severity" }, "impacted_services": { "type": "array", "description": "Impacted services represent the status page services affected by a post update, and its impact." }, "update_frequency_ms": { "type": "integer", "description": "The frequency of the next Post Update in milliseconds." }, "notify_subscribers": { "type": "boolean", "description": "Determines if the subscribers should be notified of the Post Update." }, "reported_at": { "type": "string", "description": "The date and time the Post Update was reported." }, "type": { "type": "string", "description": "The type of the object returned by the API - in this case, a Status Page Post Update." } }, "required": [ "type", "message", "status", "severity", "update_frequency_ms", "notify_subscribers", "impacted_services", "post" ] } }, "required": [ "PCID", "id", "post_id", "post_update" ]}
Team to reassign unresolved incident to. If an unresolved incident exists on both the reassignment team and the team being deleted, a duplicate will not be made. If not supplied, unresolved incidents will be made account-level.
id
string
Yes
—
The ID of the resource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "reassignment_team": { "type": "string", "description": "Team to reassign unresolved incident to. If an unresolved incident exists on both the reassignment team and the team being deleted, a duplicate will not be made. If not supplied, unresolved incidents will be made account-level." }, "id": { "type": "string", "description": "The ID of the resource." } }, "required": [ "PCID", "id" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "user_id": { "type": "string", "description": "The user ID on the team." } }, "required": [ "PCID", "id", "user_id" ]}
Time zone in which results will be rendered. This will default to the schedule’s time zone.
since
string
No
—
The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.
until
string
No
—
The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.
overflow
boolean
No
—
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.
include_next_oncall_for_user
string
No
—
Specify an user_id, and the schedule list API will return information about this user’s next on-call.
id
string
Yes
—
The ID of the resource.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_zone": { "type": "string", "description": "Time zone in which results will be rendered. This will default to the schedule's time zone." }, "since": { "type": "string", "description": "The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response." }, "until": { "type": "string", "description": "The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response." }, "overflow": { "type": "boolean", "description": "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`." }, "include_next_oncall_for_user": { "type": "string", "description": "Specify an `user_id`, and the schedule list API will return information about this user's next on-call." }, "id": { "type": "string", "description": "The ID of the resource." } }, "required": [ "PCID", "id" ]}
Array of additional Models to include in response.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "post_id": { "type": "string", "description": "The ID of the Status Page Post." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "status_page_post_update" ] }, "description": "Array of additional Models to include in response." } }, "required": [ "PCID", "id", "post_id" ]}
Array of additional Models to include in response.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "include": { "type": "string", "description": "Array of additional Models to include in response.", "enum": [ "privileges" ] } }, "required": [ "PCID", "id" ]}
Time zone in which results will be rendered. This will default to the account time zone.
limit
integer
No
—
The number of results per page.
offset
integer
No
—
Offset to start pagination search results.
total
boolean
No
—
By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.
include
string
No
—
Array of additional details to include.
user_ids
string[]
No
—
Filters the results, showing only on-calls for the specified user IDs.
escalation_policy_ids
string[]
No
—
Filters the results, showing only on-calls for the specified escalation policy IDs.
schedule_ids
string[]
No
—
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.
since
string
No
—
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. On-call shifts are limited to 90 days in the future.
until
string
No
—
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. On-call shifts are limited to 90 days in the future, and the until time cannot be before the since time.
earliest
boolean
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "time_zone": { "type": "string", "description": "Time zone in which results will be rendered. This will default to the account time zone." }, "limit": { "type": "integer", "description": "The number of results per page." }, "offset": { "type": "integer", "description": "Offset to start pagination search results." }, "total": { "type": "boolean", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information." }, "include": { "type": "string", "description": "Array of additional details to include.", "enum": [ "escalation_policies", "users", "schedules" ] }, "user_ids": { "type": "array", "items": { "type": "string" }, "description": "Filters the results, showing only on-calls for the specified user IDs." }, "escalation_policy_ids": { "type": "array", "items": { "type": "string" }, "description": "Filters the results, showing only on-calls for the specified escalation policy IDs." }, "schedule_ids": { "type": "array", "items": { "type": "string" }, "description": "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." }, "since": { "type": "string", "description": "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. On-call shifts are limited to 90 days in the future." }, "until": { "type": "string", "description": "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. On-call shifts are limited to 90 days in the future, and the `until` time cannot be before the `since` time." }, "earliest": { "type": "boolean", "description": "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." } }, "required": [ "PCID" ]}
The start of the date range over which you want to search.
until
string
Yes
—
The end of the date range over which you want to search.
editable
boolean
No
—
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.
overflow
boolean
No
—
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.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "since": { "type": "string", "description": "The start of the date range over which you want to search." }, "until": { "type": "string", "description": "The end of the date range over which you want to search." }, "editable": { "type": "boolean", "description": "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." }, "overflow": { "type": "boolean", "description": "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." } }, "required": [ "PCID", "id", "since", "until" ]}
The start of the date range over which you want to search.
until
string
No
—
The end of the date range over which you want to search.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "since": { "type": "string", "description": "The start of the date range over which you want to search." }, "until": { "type": "string", "description": "The end of the date range over which you want to search." } }, "required": [ "PCID", "id" ]}
By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.
query
string
No
—
Filters the result, showing only the records whose name matches the query.
include
string
No
—
Array of additional details to include.
time_zone
string
No
—
Time zone in which results will be rendered. This will default to the current user’s time zone and then the account’s time zone.
include_next_oncall_for_user
string
No
—
Specify an user_id, and the schedule list API will return information about this user’s next on-call.
since
string
No
—
The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.
until
string
No
—
The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The number of results per page." }, "offset": { "type": "integer", "description": "Offset to start pagination search results." }, "total": { "type": "boolean", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information." }, "query": { "type": "string", "description": "Filters the result, showing only the records whose name matches the query." }, "include": { "type": "string", "description": "Array of additional details to include.", "enum": [ "schedule_layers", "overrides_subschedule", "final_schedule" ] }, "time_zone": { "type": "string", "description": "Time zone in which results will be rendered. This will default to the current user's time zone and then the account's time zone." }, "include_next_oncall_for_user": { "type": "string", "description": "Specify an `user_id`, and the schedule list API will return information about this user's next on-call." }, "since": { "type": "string", "description": "The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response." }, "until": { "type": "string", "description": "The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response." } }, "required": [ "PCID" ]}
Filter by the reviewed status of the Post Update to retrieve.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "post_id": { "type": "string", "description": "The ID of the Status Page Post." }, "reviewed_status": { "type": "string", "description": "Filter by the reviewed status of the Post Update to retrieve.", "enum": [ "approved", "not_reviewed" ] } }, "required": [ "PCID", "id", "post_id" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status_page_type": { "type": "string", "description": "The type of the Status Page.", "enum": [ "public", "private" ] } }, "required": [ "PCID" ]}
By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.
id
string
Yes
—
The ID of the resource.
include
string
No
—
Array of additional Models to include in response.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The number of results per page." }, "offset": { "type": "integer", "description": "Offset to start pagination search results." }, "total": { "type": "boolean", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information." }, "id": { "type": "string", "description": "The ID of the resource." }, "include": { "type": "string", "description": "Array of additional Models to include in response.", "enum": [ "users" ] } }, "required": [ "PCID", "id" ]}
By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.
query
string
No
—
Filters the result, showing only the records whose name matches the query.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "The number of results per page." }, "offset": { "type": "integer", "description": "Offset to start pagination search results." }, "total": { "type": "boolean", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information." }, "query": { "type": "string", "description": "Filters the result, showing only the records whose name matches the query." } }, "required": [ "PCID" ]}
Filters the result, showing only the records whose name matches the query.
team_ids
string[]
No
—
An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
limit
integer
No
—
The number of results per page.
offset
integer
No
—
Offset to start pagination search results.
total
boolean
No
—
By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.
include
string
No
—
Array of additional Models to include in response.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Filters the result, showing only the records whose name matches the query." }, "team_ids": { "type": "array", "items": { "type": "string" }, "description": "An array of team IDs. Only results related to these teams will be returned. Account must have the `teams` ability to use this parameter." }, "limit": { "type": "integer", "description": "The number of results per page." }, "offset": { "type": "integer", "description": "Offset to start pagination search results." }, "total": { "type": "boolean", "description": "By default the `total` field in pagination responses is set to `null` to provide the fastest possible response times. Set `total` to `true` for this field to be populated. See our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information." }, "include": { "type": "string", "description": "Array of additional Models to include in response.", "enum": [ "contact_methods", "notification_rules", "teams", "subdomains" ] } }, "required": [ "PCID" ]}
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.
schedule
object
Yes
—
The schedule value
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "overflow": { "type": "boolean", "description": "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`." }, "schedule": { "description": "The schedule value" } }, "required": [ "PCID", "id", "schedule" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "team": { "description": "The team value" } }, "required": [ "PCID", "id", "team" ]}
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The ID of the resource." }, "user_id": { "type": "string", "description": "The user ID on the team." }, "role": { "type": "string", "description": "The role of the user on the team.", "enum": [ "observer", "responder", "manager" ] } }, "required": [ "PCID", "id", "user_id" ]}