Message
\",\"update_frequency_ms\":null,\"notify_subscribers\":false,\"severity\":{\"id\":\"PY5OM08\",\"type\":\"status_page_severity\"},\"status\":{\"id\":\"P0400H4\",\"type\":\"status_page_status\"},\"type\":\"status_page_post_update\"}]}}\n\n@endpoint GET /status_pages/{id}/posts/{post_id}\n@desc Get a Status Page Post\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@optional {include[]: [str]: any # Array of additional Models to include in response.}\n@returns(200) {post: map{id: str, self: str, type: str, post_type: str, status_page: map{id: str, type: str}, linked_resource: map{id: str, type: str}, postmortem: map{id: str, type: str}, title: str, starts_at: str(date-time)?, ends_at: str(date-time)?, updates: [map]}} # OK\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /status_pages/{id}/posts/{post_id}\n@desc Update a Status Page Post\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., post: map{type!: str, title!: str, post_type!: str, starts_at!: str(date-time), ends_at!: str(date-time), status_page!: map} # Request schema for creating a given Status Page Post resource.}\n@returns(200) {post: map{id: str, self: str, type: str, post_type: str, status_page: map{id: str, type: str}, linked_resource: map{id: str, type: str}, postmortem: map{id: str, type: str}, title: str, starts_at: str(date-time)?, ends_at: str(date-time)?, updates: [map]}} # OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"post\":{\"ends_at\":\"2023-12-12T11:00:00.000Z\",\"post_type\":\"maintenance\",\"starts_at\":\"2023-12-12T11:00:00.000Z\",\"status_page\":{\"id\":\"PR5LMML\",\"type\":\"status_page\"},\"title\":\"maintenance window for database upgrade\",\"type\":\"status_page_post\"}}\n\n@endpoint DELETE /status_pages/{id}/posts/{post_id}\n@desc Delete a Status Page Post\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@returns(204) No Content\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /status_pages/{id}/posts/{post_id}/post_updates\n@desc List Status Page Post Updates\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@optional {reviewed_status: str(approved/not_reviewed) # Filter by the reviewed status of the Post Update to retrieve.}\n@returns(200) OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint POST /status_pages/{id}/posts/{post_id}/post_updates\n@desc Create a Status Page Post Update\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., post_update: map{self: str, post!: map, message!: str, status!: map, severity!: map, impacted_services!: [map], update_frequency_ms!: int, notify_subscribers!: bool, reported_at: str(date-time), type!: str} # Attributes for Post Update creation/update}\n@returns(201) {post_update: map{id: str, self: str, post: map{id: str, type: str}, message: str, reviewed_status: str, status: map{id: str, type: str}, severity: map{id: str, type: str}, impacted_services: [map], update_frequency_ms: int?, notify_subscribers: bool, reported_at: str(date-time)?, type: str}} # Created\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"post_update\":{\"impacted_services\":[{\"impact\":{\"id\":\"PY5OM08\",\"type\":\"status_page_impact\"},\"service\":{\"id\":\"PYHMEI3\",\"type\":\"status_page_service\"}}],\"message\":\"Message
\",\"notify_subscribers\":false,\"post\":{\"id\":\"P6F2CJ3\",\"type\":\"status_page_post\"},\"severity\":{\"id\":\"PY5OM08\",\"type\":\"status_page_severity\"},\"status\":{\"id\":\"P0400H4\",\"type\":\"status_page_status\"},\"type\":\"status_page_post_update\"}}\n\n@endpoint GET /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}\n@desc Get a Status Page Post Update\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., post_update_id: str # The ID of the Status Page Post Update.}\n@returns(200) {post_update: map{id: str, self: str, post: map{id: str, type: str}, message: str, reviewed_status: str, status: map{id: str, type: str}, severity: map{id: str, type: str}, impacted_services: [map], update_frequency_ms: int?, notify_subscribers: bool, reported_at: str(date-time)?, type: str}} # OK\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}\n@desc Update a Status Page Post Update\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., post_update_id: str # The ID of the Status Page Post Update., post_update: map{self: str, post!: map, message!: str, status!: map, severity!: map, impacted_services!: [map], update_frequency_ms!: int, notify_subscribers!: bool, reported_at: str(date-time), type!: str} # Attributes for Post Update creation/update}\n@returns(200) {post_update: map{id: str, self: str, post: map{id: str, type: str}, message: str, reviewed_status: str, status: map{id: str, type: str}, severity: map{id: str, type: str}, impacted_services: [map], update_frequency_ms: int?, notify_subscribers: bool, reported_at: str(date-time)?, type: str}} # OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"post_update\":{\"impacted_services\":[{\"impact\":{\"id\":\"PY5OM08\",\"type\":\"status_page_impact\"},\"service\":{\"id\":\"PYHMEI3\",\"type\":\"status_page_service\"}}],\"message\":\"Message
\",\"notify_subscribers\":false,\"post\":{\"id\":\"P6F2CJ3\",\"type\":\"status_page_post\"},\"severity\":{\"id\":\"PY5OM08\",\"type\":\"status_page_severity\"},\"status\":{\"id\":\"P0400H4\",\"type\":\"status_page_status\"},\"type\":\"status_page_post_update\"}}\n\n@endpoint DELETE /status_pages/{id}/posts/{post_id}/post_updates/{post_update_id}\n@desc Delete a Status Page Post Update\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., post_update_id: str # The ID of the Status Page Post Update.}\n@returns(204) No Content\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /status_pages/{id}/posts/{post_id}/postmortem\n@desc Get a Post Postmortem\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@returns(200) {postmortem: map{id: str, self: str, post: map{id: str, type: str}, message: str, notify_subscribers: bool, reported_at: str(date-time), type: str}} # OK\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint POST /status_pages/{id}/posts/{post_id}/postmortem\n@desc Create a Post Postmortem\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@optional {postmortem: map{type!: str, post!: map, message!: str, notify_subscribers!: bool} # Request to create/update a given Postmortem resource.}\n@returns(201) {postmortem: map{id: str, self: str, post: map{id: str, type: str}, message: str, notify_subscribers: bool, reported_at: str(date-time), type: str}} # Created\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"postmortem\":{\"message\":\"Something wrong happened and this is a postmortem.
\",\"notify_subscribers\":true,\"post\":{\"id\":\"P6F2CJ3\",\"self\":\"https://api.pagerduty.com/status_pages/PR5LMML/posts/P6F2CJ3\",\"type\":\"status_page_post\"},\"type\":\"status_page_post_postmortem\"}}\n\n@endpoint PUT /status_pages/{id}/posts/{post_id}/postmortem\n@desc Update a Post Postmortem\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post., postmortem: map{type!: str, post!: map, message!: str, notify_subscribers!: bool} # Request to create/update a given Postmortem resource.}\n@returns(200) {postmortem: map{id: str, self: str, post: map{id: str, type: str}, message: str, notify_subscribers: bool, reported_at: str(date-time), type: str}} # OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"postmortem\":{\"message\":\"
Something wrong happened and this is a postmortem.
\",\"notify_subscribers\":true,\"post\":{\"id\":\"P6F2CJ3\",\"self\":\"https://api.pagerduty.com/status_pages/PR5LMML/posts/P6F2CJ3\",\"type\":\"status_page_post\"},\"type\":\"status_page_post_postmortem\"}}\n\n@endpoint DELETE /status_pages/{id}/posts/{post_id}/postmortem\n@desc Delete a Post Postmortem\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., post_id: str # The ID of the Status Page Post.}\n@returns(204) No Content\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /status_pages/{id}/subscriptions\n@desc List Status Page Subscriptions\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource.}\n@optional {status: str(active/pending) # Filter by Subscription status., channel: str(webhook/email/slack) # Filter by Subscription channel.}\n@returns(200) OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint POST /status_pages/{id}/subscriptions\n@desc Create a Status Page Subscription\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., subscription: map{channel!: str, contact!: str, status_page!: map, subscribable_object!: map, type!: str} # Request schema for creating a StatusPageSubscription.}\n@returns(201) {subscription: map{channel: str, contact: str, id: str, self: str, status: str, status_page: map{id: str, type: str}, subscribable_object: map{id: str, type: str}, type: str}} # Created\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"subscription\":{\"channel\":\"email\",\"contact\":\"joe@email.example\",\"status_page\":{\"id\":\"PIJ90N7\",\"type\":\"status_page\"},\"subscribable_object\":{\"id\":\"PSX4LJI\",\"type\":\"status_page_service\"},\"type\":\"status_page_subscription\"}}\n\n@endpoint GET /status_pages/{id}/subscriptions/{subscription_id}\n@desc Get a Status Page Subscription\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., subscription_id: str # The ID of the Status Page subscription.}\n@returns(200) {subscription: map{channel: str, contact: str, id: str, self: str, status: str, status_page: map{id: str, type: str}, subscribable_object: map{id: str, type: str}, type: str}} # OK\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint DELETE /status_pages/{id}/subscriptions/{subscription_id}\n@desc Delete a Status Page Subscription\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., subscription_id: str # The ID of the Status Page subscription.}\n@returns(204) No Content\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endgroup\n\n@group sre_agent\n@endpoint GET /sre_agent/memories\n@desc List SRE Agent memories\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json}\n@optional {limit: int=20 - incident_summary # The number of results to return per page., service_id: str # Filter memories by service ID, incident_id: str # Filter memories by incident ID, type: str(runbook/service_profile/incident_playbook) # Filter memories by type}\n@returns(200) An array of SRE Agent memories.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /sre_agent/memories/{id}\n@desc Update an SRE Agent memory\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., memory: map{content!: str}}\n@returns(200) {memory: map{id: str, content: str, attributes: map{account_id: str, service_id: str, incident_id: str, type: str}, created_at: str(date-time), updated_at: str(date-time)}} # The SRE Agent memory that was updated.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"memory\":{\"content\":\"Updated memory content - The database connection pool was increased to 100 connections to resolve performance issues during peak load.\"}}\n\n@endpoint DELETE /sre_agent/memories/{id}\n@desc Delete an SRE Agent memory\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@returns(204) The SRE Agent memory was deleted successfully.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags\n@desc List tags\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json}\n@optional {limit: int # The number of results per page., offset: int # Offset to start pagination search results., total: bool=false # 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: str # Filters the result, showing only the tags whose label matches the query.}\n@returns(200) An array of tags names.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint POST /tags\n@desc Create a tag\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, tag: any}\n@returns(201) {tag: any} # The tag that was created.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"tag\":{\"type\":\"tag\",\"label\":\"Batman\"}}\n\n@endpoint GET /tags/{id}\n@desc Get a tag\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@returns(200) {tag: any} # The tag requested.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint DELETE /tags/{id}\n@desc Delete a tag\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@returns(204) The tag was deleted successfully.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /tags/{id}/{entity_type}\n@desc Get connected entities\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., entity_type: str(users/teams/escalation_policies) # Type of entity related with the tag}\n@optional {limit: int # The number of results per page., offset: int # Offset to start pagination search results., total: bool=false # 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.}\n@returns(200) An array of connected entities.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endgroup\n\n@group teams\n@endpoint POST /teams\n@desc Create a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, team: any}\n@returns(201) {team: any} # The team that was created.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"team\":{\"type\":\"team\",\"name\":\"Engineering\",\"description\":\"The engineering team\"}}\n\n@endpoint GET /teams\n@desc List teams\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json}\n@optional {limit: int # The number of results per page., offset: int # Offset to start pagination search results., total: bool=false # 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: str # Filters the result, showing only the records whose name matches the query.}\n@returns(200) A paginated array of teams.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /teams/{id}\n@desc Get a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@optional {include[]: str: any # Array of additional Models to include in response.}\n@returns(200) {team: any} # The team requested.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint DELETE /teams/{id}\n@desc Delete a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@optional {reassignment_team: str # 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.}\n@returns(204) The team was deleted successfully.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /teams/{id}\n@desc Update a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., team: any}\n@returns(200) {team: any} # The team that was updated.\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"team\":{\"type\":\"team\",\"name\":\"Engineering\",\"description\":\"The engineering team\"}}\n\n@endpoint GET /teams/{id}/audit/records\n@desc List audit records for a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@optional {limit: int # The minimum of the `limit` parameter used in the request or the maximum request size of the API., cursor: str # Optional parameter used to request the \"next\" set of results from an API. The value provided here is most commonly obtained from the `next_cursor` field of the previous request. When no value is provided, the request starts at the beginning of the result set., since: str(date-time) # The start of the date range over which you want to search. If not specified, defaults to `now() - 24 hours` (past 24 hours), until: str(date-time) # The end of the date range over which you want to search. If not specified, defaults to `now()`. May not be more than 31 days after `since`.}\n@returns(200) Records matching the query criteria.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached., 500: Internal Server Error the PagerDuty server experienced an error.}\n\n@endpoint DELETE /teams/{id}/escalation_policies/{escalation_policy_id}\n@desc Remove an escalation policy from a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., escalation_policy_id: str # The escalation policy ID on the team.}\n@returns(204) The escalation policy was removed from the team.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /teams/{id}/escalation_policies/{escalation_policy_id}\n@desc Add an escalation policy to a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., escalation_policy_id: str # The escalation policy ID on the team.}\n@returns(204) The escalation policy was added to the team.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /teams/{id}/members\n@desc List members of a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource.}\n@optional {limit: int # The number of results per page., offset: int # Offset to start pagination search results., total: bool=false # 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[]: str # Array of additional Models to include in response.}\n@returns(200) A paginated array of users within the requested team.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint GET /teams/{id}/notification_subscriptions\n@desc List Team Notification Subscriptions\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource.}\n@returns(200) OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint POST /teams/{id}/notification_subscriptions\n@desc Create Team Notification Subscriptions\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., subscribables: [map{subscribable_id: str, subscribable_type: str}]}\n@returns(200) {subscriptions: [map]} # OK\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 422: Unprocessable Entity. Some arguments failed validation checks.}\n@example_request {\"subscribables\":[{\"subscribable_type\":\"incident\",\"subscribable_id\":\"PD1234\"},{\"subscribable_type\":\"business_service\",\"subscribable_id\":\"PD1234\"},{\"subscribable_type\":\"business_service\",\"subscribable_id\":\"PD1235\"}]}\n\n@endpoint POST /teams/{id}/notification_subscriptions/unsubscribe\n@desc Unsubscribe the given Team from Notifications on the matching Subscribable entities.\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., id: str # The ID of the resource., subscribables: [map{subscribable_id: str, subscribable_type: str}]}\n@returns(200) {deleted_count: num, unauthorized_count: num, non_existent_count: num} # OK\n@errors {401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 422: Unprocessable Entity. Some arguments failed validation checks.}\n@example_request {\"subscribables\":[{\"subscribable_type\":\"incident\",\"subscribable_id\":\"PD1234\"},{\"subscribable_type\":\"business_service\",\"subscribable_id\":\"PD1234\"}]}\n\n@endpoint DELETE /teams/{id}/users/{user_id}\n@desc Remove a user from a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., user_id: str # The user ID on the team.}\n@returns(204) The user was removed to the team.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n\n@endpoint PUT /teams/{id}/users/{user_id}\n@desc Add a user to a team\n@required {Accept: str=application/vnd.pagerduty+json;version=2 # The `Accept` header is used as a versioning header., Content-Type: str=application/json, id: str # The ID of the resource., user_id: str # The user ID on the team.}\n@optional {role: str(observer/responder/manager) # The role of the user on the team.}\n@returns(204) The user was added to the team.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 401: Caller did not supply credentials or did not provide the correct credentials. If you are using an API key, it may be invalid or your Authorization header may be malformed., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 404: The requested resource was not found., 429: Too many requests have been made, the rate limit has been reached.}\n@example_request {\"role\":\"observer\"}\n\n@endgroup\n\n@group templates\n@endpoint GET /templates\n@desc List templates\n@optional {limit: int # The number of results per page., offset: int # Offset to start pagination search results., total: bool=false # 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: str # Template name or description to search, template_type: str=status_update # Filters templates by type., sort_by: str(name/name:asc/name:desc/created_at/created_at:asc/created_at:desc)=created_at:asc # Used to specify both the field you wish to sort the results on (name/created_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. Sort direction defaults to ascending.}\n@returns(200) A paginated array of templates.\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 500: Internal Server Error the PagerDuty server experienced an error.}\n\n@endpoint POST /templates\n@desc Create a template\n@required {template: map{template_type: str, name: str, description: str, templated_fields: map}}\n@returns(201) {template: any} # Template successfully created\n@errors {400: Caller provided invalid arguments. Please review the response for error details. Retrying with the same arguments will *not* work., 402: Account does not have the abilities to perform the action. Please review the response for the required abilities. You can also use the [Abilities API](#resource_Abilities) to determine what features are available to your account., 403: Caller is not authorized to view the requested resource. While your authentication is valid, the authenticated user or token does not have permission to perform this action., 500: Internal Server Error the PagerDuty server experienced an error.}\n@example_request {\"template\":{\"description\":\"Sample template description\",\"templated_fields\":{\"email_body\":\"