pagerduty-services

PagerDuty Services — manage services, escalation policies, event orchestrations, and alert grouping

Server path: /pagerduty-services | Type: Application | PCID required: Yes

Tools

Tool	Description
pagerduty_services_create_service	Create a service
pagerduty_services_delete_alert_grouping_setting	Delete an Alert Grouping Setting
pagerduty_services_get_alert_grouping_setting	Get an Alert Grouping Setting
pagerduty_services_get_change_event	Get a Change Event
pagerduty_services_get_escalation_policy	Get an escalation policy
pagerduty_services_get_orch_path_global	Get the Global Orchestration for an Event Orchestration
pagerduty_services_get_orch_path_router	Get the Router for an Event Orchestration
pagerduty_services_get_orch_path_service	Get the Service Orchestration for a Service
pagerduty_services_get_orchestration	Get an Orchestration
pagerduty_services_get_service	Get a service
pagerduty_services_list_alert_grouping_settings	List alert grouping settings
pagerduty_services_list_change_events	List Change Events
pagerduty_services_list_escalation_policies	List escalation policies
pagerduty_services_list_event_orchestrations	List Event Orchestrations
pagerduty_services_list_incident_related_change_events	List related Change Events for an Incident
pagerduty_services_list_service_change_events	List Change Events for a service
pagerduty_services_list_services	List services
pagerduty_services_post_alert_grouping_settings	Create an Alert Grouping Setting
pagerduty_services_put_alert_grouping_setting	Update an Alert Grouping Setting
pagerduty_services_update_orch_path_router	Update the Router for an Event Orchestration
pagerduty_services_update_service	Update a service

---

pagerduty_services_create_service

Create a service

Parameters:

Parameter	Type	Required	Default	Description
service	object	Yes	—	The service value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "service": {
      "description": "The service value"
    }
  },
  "required": [
    "PCID",
    "service"
  ]
}

---

pagerduty_services_delete_alert_grouping_setting

Delete an Alert Grouping Setting

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the 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."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_alert_grouping_setting

Get an Alert Grouping Setting

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the 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."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_change_event

Get a Change Event

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the 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."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_escalation_policy

Get an escalation policy

Parameters:

Parameter	Type	Required	Default	Description
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"
    },
    "id": {
      "type": "string",
      "description": "The ID of the resource."
    },
    "include": {
      "type": "string",
      "description": "Array of additional Models to include in response.",
      "enum": [
        "services",
        "teams",
        "targets"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_orch_path_global

Get the Global Orchestration for an Event Orchestration

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of an Event Orchestration.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of an Event Orchestration."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_orch_path_router

Get the Router for an Event Orchestration

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of an Event Orchestration.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of an Event Orchestration."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_orch_path_service

Get the Service Orchestration for a Service

Parameters:

Parameter	Type	Required	Default	Description
service_id	string	Yes	—	The service ID
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"
    },
    "service_id": {
      "type": "string",
      "description": "The service ID"
    },
    "include": {
      "type": "string",
      "description": "Array of additional Models to include in response.",
      "enum": [
        "migrated_metadata"
      ]
    }
  },
  "required": [
    "PCID",
    "service_id"
  ]
}

---

pagerduty_services_get_orchestration

Get an Orchestration

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of an Event Orchestration.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of an Event Orchestration."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_get_service

Get a service

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the resource.
include	string	No	—	Array of additional details to include.

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 details to include.",
      "enum": [
        "escalation_policies",
        "teams",
        "auto_pause_notifications_parameters",
        "integrations"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_list_alert_grouping_settings

List alert grouping settings

Parameters:

Parameter	Type	Required	Default	Description
after	string	No	—	Cursor to retrieve next page; only present if next page exists.
before	string	No	—	Cursor to retrieve previous page; only present if not on first page.
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.
limit	integer	No	—	The number of results per page.
service_ids	string[]	No	—	An array of service IDs. Only results related to these services will be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "after": {
      "type": "string",
      "description": "Cursor to retrieve next page; only present if next page exists."
    },
    "before": {
      "type": "string",
      "description": "Cursor to retrieve previous page; only present if not on first page."
    },
    "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."
    },
    "limit": {
      "type": "integer",
      "description": "The number of results per page."
    },
    "service_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of service IDs. Only results related to these services will be returned."
    }
  },
  "required": [
    "PCID"
  ]
}

---

pagerduty_services_list_change_events

List Change Events

Parameters:

Parameter	Type	Required	Default	Description
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.
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.
integration_ids	string[]	No	—	An array of integration IDs. Only results related to these integrations will be returned.
since	string	No	—	The 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.
until	string	No	—	The 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.

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."
    },
    "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."
    },
    "integration_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of integration IDs. Only results related to these integrations will be returned."
    },
    "since": {
      "type": "string",
      "description": "The 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."
    },
    "until": {
      "type": "string",
      "description": "The 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."
    }
  },
  "required": [
    "PCID"
  ]
}

---

pagerduty_services_list_escalation_policies

List escalation policies

Parameters:

Parameter	Type	Required	Default	Description
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.
query	string	No	—	Filters the result, showing only the records whose name matches the query.
user_ids	string[]	No	—	Filters the results, showing only escalation policies on which any of the users is a target.
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.
include	string	No	—	Array of additional Models to include in response.
sort_by	string	No	—	Used to specify the field you wish to sort the results on.

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."
    },
    "user_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filters the results, showing only escalation policies on which any of the users is a target."
    },
    "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."
    },
    "include": {
      "type": "string",
      "description": "Array of additional Models to include in response.",
      "enum": [
        "services",
        "teams",
        "targets"
      ]
    },
    "sort_by": {
      "type": "string",
      "description": "Used to specify the field you wish to sort the results on.",
      "enum": [
        "name",
        "name:asc",
        "name:desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

pagerduty_services_list_event_orchestrations

List Event Orchestrations

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	The number of results per page.
offset	integer	No	—	Offset to start pagination search results.
sort_by	string	No	—	Used to specify the field you wish to sort the results on.

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."
    },
    "sort_by": {
      "type": "string",
      "description": "Used to specify the field you wish to sort the results on.",
      "enum": [
        "name:asc",
        "name:desc",
        "routes:asc",
        "routes:desc",
        "created_at:asc",
        "created_at:desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

pagerduty_services_list_incident_related_change_events

List related Change Events for an Incident

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the resource.
limit	integer	No	—	The number of results per page.

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."
    },
    "limit": {
      "type": "integer",
      "description": "The number of results per page."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_list_service_change_events

List Change Events for a service

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the resource.
since	string	No	—	The 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.
until	string	No	—	The 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.
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.
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.
integration_ids	string[]	No	—	An array of integration IDs. Only results related to these integrations will be returned.

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, as a UTC ISO 8601 datetime string. Will return an HTTP 400 for non-UTC datetimes."
    },
    "until": {
      "type": "string",
      "description": "The 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."
    },
    "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."
    },
    "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."
    },
    "integration_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of integration IDs. Only results related to these integrations will be returned."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pagerduty_services_list_services

List services

Parameters:

Parameter	Type	Required	Default	Description
query	string	No	—	Filters the result, showing only the records whose name matches the query.
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.
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.
time_zone	string	No	—	Time zone in which results will be rendered. This will default to the account time zone.
sort_by	string	No	—	Used to specify the field you wish to sort the results on.
include	string	No	—	Array of additional details to include.
name	string	No	—	Filters the results, showing only services with the specified name.

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."
    },
    "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."
    },
    "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."
    },
    "time_zone": {
      "type": "string",
      "description": "Time zone in which results will be rendered. This will default to the account time zone."
    },
    "sort_by": {
      "type": "string",
      "description": "Used to specify the field you wish to sort the results on.",
      "enum": [
        "name",
        "name:asc",
        "name:desc"
      ]
    },
    "include": {
      "type": "string",
      "description": "Array of additional details to include.",
      "enum": [
        "escalation_policies",
        "teams",
        "integrations",
        "auto_pause_notifications_parameters"
      ]
    },
    "name": {
      "type": "string",
      "description": "Filters the results, showing only services with the specified name."
    }
  },
  "required": [
    "PCID"
  ]
}

---

pagerduty_services_post_alert_grouping_settings

Create an Alert Grouping Setting

Parameters:

Parameter	Type	Required	Default	Description
alert_grouping_setting	object	Yes	—	Defines 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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alert_grouping_setting": {
      "type": "object",
      "description": "Defines 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.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "An optional short-form string that provides succinct information about an AlertGroupingSetting object suitable for primary labeling of the entity. It is not intended to be an identifier."
        },
        "description": {
          "type": "string",
          "description": "An optional description in string that provides more information about an AlertGroupingSetting object."
        },
        "type": {
          "type": "string",
          "description": "The type value"
        },
        "config": {
          "description": "The config value"
        },
        "services": {
          "type": "array",
          "description": "The array of one or many Services with just ServiceID/name that the AlertGroupingSetting applies to. Type of content_based_intelligent allows for only one service in the array."
        },
        "created_at": {
          "type": "string",
          "description": "The ISO8601 date/time an AlertGroupingSetting got created at."
        },
        "updated_at": {
          "type": "string",
          "description": "The ISO8601 date/time an AlertGroupingSetting last got updated at."
        }
      }
    }
  },
  "required": [
    "PCID",
    "alert_grouping_setting"
  ]
}

---

pagerduty_services_put_alert_grouping_setting

Update an Alert Grouping Setting

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the resource.
alert_grouping_setting	object	Yes	—	Defines 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.

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."
    },
    "alert_grouping_setting": {
      "type": "object",
      "description": "Defines 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.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "An optional short-form string that provides succinct information about an AlertGroupingSetting object suitable for primary labeling of the entity. It is not intended to be an identifier."
        },
        "description": {
          "type": "string",
          "description": "An optional description in string that provides more information about an AlertGroupingSetting object."
        },
        "type": {
          "type": "string",
          "description": "The type value"
        },
        "config": {
          "description": "The config value"
        },
        "services": {
          "type": "array",
          "description": "The array of one or many Services with just ServiceID/name that the AlertGroupingSetting applies to. Type of content_based_intelligent allows for only one service in the array."
        },
        "created_at": {
          "type": "string",
          "description": "The ISO8601 date/time an AlertGroupingSetting got created at."
        },
        "updated_at": {
          "type": "string",
          "description": "The ISO8601 date/time an AlertGroupingSetting last got updated at."
        }
      }
    }
  },
  "required": [
    "PCID",
    "id",
    "alert_grouping_setting"
  ]
}

---

pagerduty_services_update_orch_path_router

Update the Router for an Event Orchestration

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of an Event Orchestration.
orchestration_path	object	Yes	—	Orchestration Path

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of an Event Orchestration."
    },
    "orchestration_path": {
      "description": "Orchestration Path"
    }
  },
  "required": [
    "PCID",
    "id",
    "orchestration_path"
  ]
}

---

pagerduty_services_update_service

Update a service

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the resource.
service	object	Yes	—	The service 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."
    },
    "service": {
      "description": "The service value"
    }
  },
  "required": [
    "PCID",
    "id",
    "service"
  ]
}