services

Overview

Name	services
Type	Resource
Id	pagerduty.services.services

Fields

Name	Datatype	Description
id	string
name	string	The name of the service.
description	string	The user-provided description of the service.
_type	string	The type of object being created.
acknowledgement_timeout	integer	Time in seconds that an incident changes to the Triggered State after being Acknowledged. Value is null if the feature is disabled. Value must not be negative. Setting this field to 0, null (or unset in POST request) will disable the feature.
addons	array	The array of Add-ons associated with this service.
alert_creation	string	Whether a service creates only incidents, or both alerts and incidents. A service must create alerts in order to enable incident merging. "create_incidents" - The service will create one incident and zero alerts for each incoming event. "create_alerts_and_incidents" - The service will create one incident and one associated alert for each incoming event.
alert_grouping	string	Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. There are three available options: null - No alert grouping on the service. Each alert will create a separate incident; "time" - All alerts within a specified duration will be grouped into the same incident. This duration is set in the alert_grouping_timeout setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; * "intelligent" - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plans
alert_grouping_parameters	object	Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. To turn grouping off set the type to null.
alert_grouping_timeout	integer	The duration in minutes within which to automatically group incoming alerts. This setting applies only when alert_grouping is set to time. To continue grouping alerts until the Incident is resolved, set this value to 0.
auto_pause_notifications_parameters	object	Defines how alerts on this service are automatically suspended for a period of time before triggering, when identified as likely being transient. Note that automatically pausing notifications is only available on certain plans.
auto_resolve_timeout	integer	Time in seconds that an incident is automatically resolved if left open for that long. Value is null if the feature is disabled. Value must not be negative. Setting this field to 0, null (or unset in POST request) will disable the feature.
created_at	string	The date/time when this service was created
escalation_policy	object
html_url	string	a URL at which the entity is uniquely displayed in the Web app
incident_urgency_rule	object
integrations	array	An array containing Integration objects that belong to this service. If integrations is passed as an argument, these are full objects - otherwise, these are references.
last_incident_timestamp	string	The date/time when the most recent incident was created for this service.
response_play	object	Response plays associated with this service.
scheduled_actions	array	An array containing scheduled actions for the service.
self	string	the API show URL at which the object is accessible
status	string	The current state of the Service. Valid statuses are: - active: The service is enabled and has no open incidents. This is the only status a service can be created with. - warning: The service is enabled and has one or more acknowledged incidents. - critical: The service is enabled and has one or more triggered incidents. - maintenance: The service is under maintenance, no new incidents will be triggered during maintenance mode. - disabled: The service is disabled and will not have any new triggered incidents.
summary	string	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.
support_hours	object
teams	array	The set of teams associated with this service.
type	string	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.

Methods

Name	Accessible by	Required Params	Description
get_service	SELECT	id	Get details about an existing service. A service may represent an application, component, or team you wish to open incidents against. For more information see the API Concepts Document Scoped OAuth requires: services.read
list_services	SELECT		List existing Services. A service may represent an application, component, or team you wish to open incidents against. For more information see the API Concepts Document Scoped OAuth requires: services.read
create_service	INSERT	data__service	Create a new service. If status is included in the request, it must have a value of active when creating a new service. If a different status is required, make a second request to update the service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 25,000 services per account. If the limit is reached, the API will respond with an error. There is also a limit of 100,000 open Incidents per Service. If the limit is reached and auto_resolve_timeout is disabled (set to 0 or null), the auto_resolve_timeout property will automatically be set to 84600 (1 day). For more information see the API Concepts Document Scoped OAuth requires: services.write
delete_service	DELETE	id	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. A service may represent an application, component, or team you wish to open incidents against. For more information see the API Concepts Document Scoped OAuth requires: services.write
_get_service	EXEC	id	Get details about an existing service. A service may represent an application, component, or team you wish to open incidents against. For more information see the API Concepts Document Scoped OAuth requires: services.read
_list_services	EXEC		List existing Services. A service may represent an application, component, or team you wish to open incidents against. For more information see the API Concepts Document Scoped OAuth requires: services.read
update_service	EXEC	id, data__service	Update an existing service. A service may represent an application, component, or team you wish to open incidents against. There is a limit of 100,000 open Incidents per Service. If the limit is reached and you disable auto_resolve_timeout (set to 0 or null), the API will respond with an error. For more information see the API Concepts Document Scoped OAuth requires: services.write