Skip to main content
Server path: /pagerduty-services | Type: Application | PCID required: Yes

Tools

ToolDescription
pagerduty_services_create_serviceCreate a service
pagerduty_services_delete_alert_grouping_settingDelete an Alert Grouping Setting
pagerduty_services_get_alert_grouping_settingGet an Alert Grouping Setting
pagerduty_services_get_change_eventGet a Change Event
pagerduty_services_get_escalation_policyGet an escalation policy
pagerduty_services_get_orch_path_globalGet the Global Orchestration for an Event Orchestration
pagerduty_services_get_orch_path_routerGet the Router for an Event Orchestration
pagerduty_services_get_orch_path_serviceGet the Service Orchestration for a Service
pagerduty_services_get_orchestrationGet an Orchestration
pagerduty_services_get_serviceGet a service
pagerduty_services_list_alert_grouping_settingsList alert grouping settings
pagerduty_services_list_change_eventsList Change Events
pagerduty_services_list_escalation_policiesList escalation policies
pagerduty_services_list_event_orchestrationsList Event Orchestrations
pagerduty_services_list_incident_related_change_eventsList related Change Events for an Incident
pagerduty_services_list_service_change_eventsList Change Events for a service
pagerduty_services_list_servicesList services
pagerduty_services_post_alert_grouping_settingsCreate an Alert Grouping Setting
pagerduty_services_put_alert_grouping_settingUpdate an Alert Grouping Setting
pagerduty_services_update_orch_path_routerUpdate the Router for an Event Orchestration
pagerduty_services_update_serviceUpdate a service

pagerduty_services_create_service

Create a service Parameters:
ParameterTypeRequiredDefaultDescription
serviceobjectYesThe service value

pagerduty_services_delete_alert_grouping_setting

Delete an Alert Grouping Setting Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.

pagerduty_services_get_alert_grouping_setting

Get an Alert Grouping Setting Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.

pagerduty_services_get_change_event

Get a Change Event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.

pagerduty_services_get_escalation_policy

Get an escalation policy Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
includestringNoArray of additional Models to include in response.

pagerduty_services_get_orch_path_global

Get the Global Orchestration for an Event Orchestration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of an Event Orchestration.

pagerduty_services_get_orch_path_router

Get the Router for an Event Orchestration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of an Event Orchestration.

pagerduty_services_get_orch_path_service

Get the Service Orchestration for a Service Parameters:
ParameterTypeRequiredDefaultDescription
service_idstringYesThe service ID
includestringNoArray of additional Models to include in response.

pagerduty_services_get_orchestration

Get an Orchestration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of an Event Orchestration.

pagerduty_services_get_service

Get a service Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
includestringNoArray of additional details to include.

pagerduty_services_list_alert_grouping_settings

List alert grouping settings Parameters:
ParameterTypeRequiredDefaultDescription
afterstringNoCursor to retrieve next page; only present if next page exists.
beforestringNoCursor to retrieve previous page; only present if not on first page.
totalbooleanNoBy 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.
limitintegerNoThe number of results per page.
service_idsstring[]NoAn array of service IDs. Only results related to these services will be returned.

pagerduty_services_list_change_events

List Change Events Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
team_idsstring[]NoAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
integration_idsstring[]NoAn array of integration IDs. Only results related to these integrations will be returned.
sincestringNoThe start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
untilstringNoThe end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.

pagerduty_services_list_escalation_policies

List escalation policies Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
querystringNoFilters the result, showing only the records whose name matches the query.
user_idsstring[]NoFilters the results, showing only escalation policies on which any of the users is a target.
team_idsstring[]NoAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
includestringNoArray of additional Models to include in response.
sort_bystringNoUsed to specify the field you wish to sort the results on.

pagerduty_services_list_event_orchestrations

List Event Orchestrations Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
sort_bystringNoUsed to specify the field you wish to sort the results on.

List related Change Events for an Incident Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
limitintegerNoThe number of results per page.

pagerduty_services_list_service_change_events

List Change Events for a service Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
sincestringNoThe start of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
untilstringNoThe end of the date range over which you want to search, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes.
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
team_idsstring[]NoAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
integration_idsstring[]NoAn array of integration IDs. Only results related to these integrations will be returned.

pagerduty_services_list_services

List services Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoFilters the result, showing only the records whose name matches the query.
limitintegerNoThe number of results per page.
offsetintegerNoOffset to start pagination search results.
totalbooleanNoBy 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.
team_idsstring[]NoAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
time_zonestringNoTime zone in which results will be rendered. This will default to the account time zone.
sort_bystringNoUsed to specify the field you wish to sort the results on.
includestringNoArray of additional details to include.
namestringNoFilters the results, showing only services with the specified name.

pagerduty_services_post_alert_grouping_settings

Create an Alert Grouping Setting Parameters:
ParameterTypeRequiredDefaultDescription
alert_grouping_settingobjectYesDefines how alerts will be automatically grouped into incidents based on the configurations defined. Note that the Alert Grouping Setting features are available only on certain plans.

pagerduty_services_put_alert_grouping_setting

Update an Alert Grouping Setting Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
alert_grouping_settingobjectYesDefines how alerts will be automatically grouped into incidents based on the configurations defined. Note that the Alert Grouping Setting features are available only on certain plans.

pagerduty_services_update_orch_path_router

Update the Router for an Event Orchestration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of an Event Orchestration.
orchestration_pathobjectYesOrchestration Path

pagerduty_services_update_service

Update a service Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the resource.
serviceobjectYesThe service value