Module pagerduty

ballerinax/pagerduty Ballerina library

1.5.2

Overview

The Pagerduty REST API v2 connector(https://developer.pagerduty.com/api-reference/) OpenAPI specification. The Pagerduty REST API provides capability to programmatically interact with a PagerDuty account.

This module supports Pagerduty REST API v2.

Key Features

Programmatic access to create and manage resources via REST API
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create an Pagerduty account
Obtain tokens - follow this guide

Clients

pagerduty: Client

Isolated

This is a generated connector for Pagerduty REST API v2 OpenAPI specification. The Pagerduty REST API provides capability to programmatically interact with a PagerDuty account. This document describes the PagerDuty REST APIs. For guides and examples please visit our Documentation. Our REST APIs are defined in OpenAPI v3.x. You can view the schema at github.com/PagerDuty/api-schema. Note that properties in some schemas have fields not shown by default such as readOnly, format, and default. Hover your cursor over the right column that looks like optional+1 to see the full list of fields.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Pagerduty account and obtain tokens by following this guide.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)

apiKeyConfig ApiKeysConfig - API keys for authorization

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://api.pagerduty.com" - URL of the target service

createEntityTypeByIdChangeTags

Isolated FunctionRemote Function

function createEntityTypeByIdChangeTags(string accept, string contentType, string entityType, string id, IdChangeTagsBody payload) returns json|error

Assign tags

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

entityType string - Type of entity related with the tag

id string - The ID of the resource.

payload IdChangeTagsBody -

Return Type

json|error - The tags were added and/or removed.

getEntityTypeByIdTags

Isolated FunctionRemote Function

function getEntityTypeByIdTags(string accept, string contentType, string entityType, string id, int? 'limit, int? offset, boolean total) returns InlineResponse200|error

Get tags for entities

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

entityType string - Type of entity related with the tag

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse200|error - An array of tags.

listAbilities

Isolated FunctionRemote Function

function listAbilities(string accept, string contentType) returns InlineResponse2001|error

List abilities

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

Return Type

InlineResponse2001|error - An array of ability names.

getAbility

Isolated FunctionRemote Function

function getAbility(string accept, string contentType, string id) returns Response|error

Test an ability

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The account has the requested ability.

listAddon

Isolated FunctionRemote Function

function listAddon(string accept, string contentType, int? 'limit, int? offset, boolean total, string[]? include, string[]? serviceIds, string? filter) returns InlineResponse2002|error

List installed Add-ons

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

include string[]? (default ()) - Array of additional Models to include in response.

serviceIds string[]? (default ()) - Filters the results, showing only Add-ons for the given services

filter string? (default ()) - Filters the results, showing only Add-ons of the given type

Return Type

InlineResponse2002|error - A paginated array of installed Add-ons.

createAddon

Isolated FunctionRemote Function

function createAddon(string accept, string contentType, AddonsBody payload) returns InlineResponse201|error

Install an Add-on

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload AddonsBody - The Add-on to be installed.

Return Type

InlineResponse201|error - The Add-on that was installed.

getAddon

Isolated FunctionRemote Function

function getAddon(string accept, string contentType, string id) returns AddonsBody|error

Get an Add-on

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

AddonsBody|error - The requested Add-on.

updateAddon

Isolated FunctionRemote Function

function updateAddon(string accept, string contentType, string id, AddonsIdBody payload) returns AddonsIdBody|error

Update an Add-on

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload AddonsIdBody - The Add-on to be updated.

Return Type

AddonsIdBody|error - The Add-on that was updated.

deleteAddon

Isolated FunctionRemote Function

function deleteAddon(string accept, string contentType, string id) returns Response|error

Delete an Add-on

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The Add-on was deleted successfully.

getAnalyticsMetricsIncidentsAll

Isolated FunctionRemote Function

function getAnalyticsMetricsIncidentsAll(string xEarlyAccess, string accept, string contentType, AnalyticsModel payload) returns InlineResponse2003|error

Get aggregated incident data

Parameters

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload AnalyticsModel - Parameters and filters to apply to the dataset.

Return Type

InlineResponse2003|error - OK

getAnalyticsMetricsIncidentsService

Isolated FunctionRemote Function

function getAnalyticsMetricsIncidentsService(string xEarlyAccess, string accept, string contentType, AnalyticsModel payload) returns InlineResponse2003|error

Get aggregated service data

Parameters

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload AnalyticsModel - Parameters and filters to apply to the dataset.

Return Type

InlineResponse2003|error - Currently the response only returns data for services that match the filters and have data.

getAnalyticsMetricsIncidentsTeam

Isolated FunctionRemote Function

function getAnalyticsMetricsIncidentsTeam(string xEarlyAccess, string accept, string contentType, AnalyticsModel payload) returns InlineResponse2003|error

Get aggregated team data

Parameters

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload AnalyticsModel - Parameters and filters to apply to the dataset.

Return Type

InlineResponse2003|error - Currently the response only returns data for teams that match the filters and have data.

getAnalyticsIncidents

Isolated FunctionRemote Function

function getAnalyticsIncidents(string xEarlyAccess, string accept, string contentType, RawIncidentsBody payload) returns InlineResponse2004|error

Get raw data - multiple incidents

Parameters

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload RawIncidentsBody - Parameters and filters to apply to the dataset.

Return Type

InlineResponse2004|error - OK

getAnalyticsIncidentsById

Isolated FunctionRemote Function

function getAnalyticsIncidentsById(string id, string accept, string contentType, string xEarlyAccess) returns AnalyticsRawIncident|error

Get raw data - single incident

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

listAuditRecords

Isolated FunctionRemote Function

function listAuditRecords(string accept, string contentType, int? 'limit, string? cursor, string? since, string? until, string[]? rootResourceTypes, string? actorType, string? actorId, string? methodType, string? methodTruncatedToken, string[]? actions) returns AuditRecordResponseSchema|error

List audit records

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

rootResourceTypes string[]? (default ()) - Resource type filter for the root_resource.

actorType string? (default ()) - Actor type filter.

actorId string? (default ()) - Actor Id filter. Must be qualified by providing the actor_type param.

methodType string? (default ()) - Method type filter.

methodTruncatedToken string? (default ()) - Method truncated_token filter. Must be qualified by providing the method_type param.

actions string[]? (default ()) - Action filter

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

listBusinessServices

Isolated FunctionRemote Function

function listBusinessServices(string accept, string contentType, int? 'limit, int? offset, boolean total) returns InlineResponse2005|error

List Business Services

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse2005|error - A paginated array of services.

createBusinessService

Isolated FunctionRemote Function

function createBusinessService(string accept, string contentType, BusinessServicesBody payload) returns InlineResponse2006|error

Create a Business Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload BusinessServicesBody -

Return Type

InlineResponse2006|error - The Business Service that was created.

getBusinessService

Isolated FunctionRemote Function

function getBusinessService(string accept, string contentType, string id) returns InlineResponse2006|error

Get a Business Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse2006|error - The service business requested.

updateBusinessService

Isolated FunctionRemote Function

function updateBusinessService(string accept, string contentType, string id, BusinessServicesIdBody payload) returns InlineResponse2006|error

Update a Business Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload BusinessServicesIdBody -

Return Type

InlineResponse2006|error - The Business Service that was updated.

deleteBusinessService

Isolated FunctionRemote Function

function deleteBusinessService(string accept, string contentType, string id) returns Response|error

Delete a Business Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The Business Service was deleted successfully.

createBusinessServiceAccountSubscription

Isolated FunctionRemote Function

function createBusinessServiceAccountSubscription(string accept, string id) returns InlineResponse2007|error

Create Business Service Account Subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

InlineResponse2007|error - OK

removeBusinessServiceAccountSubscription

Isolated FunctionRemote Function

function removeBusinessServiceAccountSubscription(string accept, string id) returns Response|error

Delete Business Service Account Subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

Response|error - The account was unsubscribed successfully.

getBusinessServiceSubscribers

Isolated FunctionRemote Function

function getBusinessServiceSubscribers(string accept, string id) returns InlineResponse2008|error

List Business Service Subscribers

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

InlineResponse2008|error - OK

createBusinessServiceNotificationSubscribers

Isolated FunctionRemote Function

function createBusinessServiceNotificationSubscribers(string accept, string id, IdSubscribersBody payload) returns InlineResponse2009|error

Create Business Service Subscribers

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload IdSubscribersBody - The entities to subscribe.

Return Type

InlineResponse2009|error - OK

getBusinessServiceSupportingServiceImpacts

Isolated FunctionRemote Function

function getBusinessServiceSupportingServiceImpacts(string accept, string id, string xEarlyAccess, string? additionalFields, string? ids) returns InlineResponse20010|error

List the supporting Business Services for the given Business Service Id, sorted by impacted status.

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

additionalFields string? (default ()) - Provides access to additional fields such as highest priority per business service and total impacted count

ids string? (default ()) - The IDs of the resources.

Return Type

InlineResponse20010|error - OK

removeBusinessServiceNotificationSubscriber

Isolated FunctionRemote Function

function removeBusinessServiceNotificationSubscriber(string accept, string id, IdUnsubscribeBody payload) returns InlineResponse20011|error

Remove Business Service Subscribers

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload IdUnsubscribeBody - The entities to unsubscribe.

Return Type

InlineResponse20011|error - OK

getBusinessServiceTopLevelImpactors

Isolated FunctionRemote Function

function getBusinessServiceTopLevelImpactors(string accept, string xEarlyAccess, string? ids) returns InlineResponse20012|error

List Impactors affecting Business Services

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

ids string? (default ()) - The IDs of the resources.

Return Type

InlineResponse20012|error - OK

getBusinessServiceImpacts

Isolated FunctionRemote Function

function getBusinessServiceImpacts(string accept, string xEarlyAccess, string? additionalFields, string? ids) returns InlineResponse20010|error

List Business Services sorted by impacted status

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

additionalFields string? (default ()) - Provides access to additional fields such as highest priority per business service and total impacted count

ids string? (default ()) - The IDs of the resources.

Return Type

InlineResponse20010|error - OK

getBusinessServicePriorityThresholds

Isolated FunctionRemote Function

function getBusinessServicePriorityThresholds(string accept, string xEarlyAccess) returns InlineResponse20013|error

Get the global priority threshold for a Business Service to be considered impacted by an Incident

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

Return Type

InlineResponse20013|error - OK

putBusinessServicePriorityThresholds

Isolated FunctionRemote Function

function putBusinessServicePriorityThresholds(string accept, string xEarlyAccess, BusinessServicesPriorityThresholdsBody payload) returns InlineResponse20014|error

Set the Account-level priority threshold for Business Service impact.

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

payload BusinessServicesPriorityThresholdsBody - Set the id and order of the global Priority Threshold. These values can be obtained by calling the /priorities endpoint.

Return Type

InlineResponse20014|error - OK

deleteBusinessServicePriorityThresholds

Isolated FunctionRemote Function

function deleteBusinessServicePriorityThresholds(string accept, string xEarlyAccess) returns Response|error

Deletes the account-level priority threshold for Business Service impact

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

Return Type

Response|error - The Priority Threshold for the account was successfully cleared.

listChangeEvents

Isolated FunctionRemote Function

function listChangeEvents(string accept, string contentType, int? 'limit, int? offset, boolean total, string[]? teamIds, string[]? integrationIds, string? since, string? until) returns InlineResponse20015|error

List Change Events

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

integrationIds string[]? (default ()) - An array of integration IDs. Only results related to these integrations will be returned.

since string? (default ()) - 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? (default ()) - 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.

Return Type

InlineResponse20015|error - The array of Change Events returned by the query.

createChangeEvent

Isolated FunctionRemote Function

function createChangeEvent(string accept, string contentType) returns Response|error

Create a Change Event

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

Return Type

Response|error - See Send Change Event in the V2 Events API reference.

getChangeEvent

Isolated FunctionRemote Function

function getChangeEvent(string accept, string contentType, string id) returns InlineResponse20016|error

Get a Change Event

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20016|error - The Change Event requested.

updateChangeEvent

Isolated FunctionRemote Function

function updateChangeEvent(string accept, string contentType, string id, ChangeEventsIdBody payload) returns InlineResponse20016|error

Update a Change Event

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload ChangeEventsIdBody - The Change Event to be updated.

Return Type

InlineResponse20016|error - The Change Event that was updated.

listEscalationPolicies

Isolated FunctionRemote Function

function listEscalationPolicies(string accept, string contentType, int? 'limit, int? offset, boolean total, string? query, string[]? userIds, string[]? teamIds, string[]? include, string sortBy) returns InlineResponse20017|error

List escalation policies

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

userIds string[]? (default ()) - Filters the results, showing only escalation policies on which any of the users is a target.

teamIds string[]? (default ()) - 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[]? (default ()) - Array of additional Models to include in response.

sortBy string (default "name") - Used to specify the field you wish to sort the results on.

Return Type

InlineResponse20017|error - A paginated array of escalation policy objects.

createEscalationPolicy

Isolated FunctionRemote Function

function createEscalationPolicy(string accept, string contentType, EscalationPoliciesBody payload, string? 'from) returns EscalationPoliciesBody|error

Create an escalation policy

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload EscalationPoliciesBody - The escalation policy to be created.

'from string? (default ()) - The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.

Return Type

EscalationPoliciesBody|error - The escalation policy that was created.

getEscalationPolicy

Isolated FunctionRemote Function

function getEscalationPolicy(string accept, string contentType, string id, string[]? include) returns EscalationPoliciesBody|error

Get an escalation policy

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

EscalationPoliciesBody|error - The escalation policy object.

updateEscalationPolicy

Isolated FunctionRemote Function

function updateEscalationPolicy(string accept, string contentType, string id, EscalationPoliciesIdBody payload) returns EscalationPoliciesIdBody|error

Update an escalation policy

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload EscalationPoliciesIdBody - The escalation policy to be updated.

Return Type

EscalationPoliciesIdBody|error - The escalation policy that was updated.

deleteEscalationPolicy

Isolated FunctionRemote Function

function deleteEscalationPolicy(string accept, string contentType, string id) returns Response|error

Delete an escalation policy

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The escalation policy was deleted successfully.

listEscalationPolicyAuditRecords

Isolated FunctionRemote Function

function listEscalationPolicyAuditRecords(string accept, string contentType, string id, int? 'limit, string? cursor, string? since, string? until) returns AuditRecordResponseSchema|error

List audit records for an escalation policy

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

listExtensionSchemas

Isolated FunctionRemote Function

function listExtensionSchemas(string accept, string contentType, int? 'limit, int? offset, boolean total) returns InlineResponse20018|error

List extension schemas

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20018|error - A paginated array of extension schemas.

getExtensionSchema

Isolated FunctionRemote Function

function getExtensionSchema(string accept, string contentType, string id) returns InlineResponse20019|error

Get an extension vendor

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20019|error - The extension vendor requested

listExtensions

Isolated FunctionRemote Function

function listExtensions(string accept, string contentType, int? 'limit, int? offset, boolean total, string? query, string? extensionObjectId, string? extensionSchemaId, string[]? include) returns InlineResponse20020|error

List extensions

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

extensionObjectId string? (default ()) - The id of the extension object you want to filter by.

extensionSchemaId string? (default ()) - Filter the extensions by extension vendor id.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20020|error - A paginated array of extensions.

createExtension

Isolated FunctionRemote Function

function createExtension(string accept, string contentType, ExtensionsBody payload) returns ExtensionsBody|error

Create an extension

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ExtensionsBody - The extension to be created

Return Type

ExtensionsBody|error - The extension that was created

getExtension

Isolated FunctionRemote Function

function getExtension(string accept, string contentType, string id, string[]? include) returns ExtensionsBody|error

Get an extension

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional details to include.

Return Type

ExtensionsBody|error - The extension that was requested.

updateExtension

Isolated FunctionRemote Function

function updateExtension(string accept, string contentType, string id, ExtensionsIdBody payload) returns ExtensionsIdBody|error

Update an extension

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload ExtensionsIdBody - The extension to be updated.

Return Type

ExtensionsIdBody|error - The extension that was updated.

deleteExtension

Isolated FunctionRemote Function

function deleteExtension(string accept, string contentType, string id) returns Response|error

Delete an extension

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The extension was deleted successfully.

enableExtension

Isolated FunctionRemote Function

function enableExtension(string accept, string contentType, string id) returns ExtensionsIdBody|error

Enable an extension

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

ExtensionsIdBody|error - The extension that was successfully enabled.

listIncidents

Isolated FunctionRemote Function

function listIncidents(string accept, string contentType, int? 'limit, int? offset, boolean total, string? dateRange, string? incidentKey, string[]? serviceIds, string[]? teamIds, string[]? userIds, string[]? urgencies, string timeZone, string[]? statuses, string[]? sortBy, string[]? include, string? since, string? until) returns InlineResponse20021|error

List incidents

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

dateRange string? (default ()) - When set to all, the since and until parameters and defaults are ignored.

incidentKey string? (default ()) - Incident de-duplication key. Incidents with child alerts do not have an incident key; querying by incident key will return incidents whose alerts have alert_key matching the given incident key.

serviceIds string[]? (default ()) - Returns only the incidents associated with the passed service(s). This expects one or more service IDs.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

userIds string[]? (default ()) - Returns only the incidents currently assigned to the passed user(s). This expects one or more user IDs. Note: When using the assigned_to_user filter, you will only receive incidents with statuses of triggered or acknowledged. This is because resolved incidents are not assigned to any user.

urgencies string[]? (default ()) - Array of the urgencies of the incidents to be returned. Defaults to all urgencies. Account must have the urgencies ability to do this.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

statuses string[]? (default ()) - Return only incidents with the given statuses. (More status codes may be introduced in the future.)

sortBy string[]? (default ()) - Used to specify both the field you wish to sort the results on (incident_number/created_at/resolved_at/urgency), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending. The account must have the urgencies ability to sort by the urgency.

include string[]? (default ()) - Array of additional details to include.

since string? (default ()) - The start of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

until string? (default ()) - The end of the date range over which you want to search. Maximum range is 6 months and default is 1 month.

Return Type

InlineResponse20021|error - A paginated array of incidents.

updateIncidents

Isolated FunctionRemote Function

function updateIncidents(string accept, string contentType, string 'from, IncidentsBody payload, int? 'limit, int? offset, boolean total) returns InlineResponse20021|error

Manage incidents

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'from string - The email address of a valid user associated with the account making the request.

payload IncidentsBody -

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20021|error - All of the updates succeeded.

createIncident

Isolated FunctionRemote Function

function createIncident(string accept, string contentType, string 'from, IncidentsBody1 payload) returns InlineResponse2011|error

Create an Incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'from string - The email address of a valid user associated with the account making the request.

payload IncidentsBody1 -

Return Type

InlineResponse2011|error - The incident object created.

getIncident

Isolated FunctionRemote Function

function getIncident(string accept, string contentType, string id) returns InlineResponse2011|error

Get an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse2011|error - The incident requested.

updateIncident

Isolated FunctionRemote Function

function updateIncident(string accept, string contentType, string id, string 'from, IncidentsIdBody payload) returns InlineResponse20022|error

Update an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IncidentsIdBody -

Return Type

InlineResponse20022|error - The incident was updated.

listIncidentAlerts

Isolated FunctionRemote Function

function listIncidentAlerts(string accept, string contentType, string id, int? 'limit, int? offset, boolean total, string? alertKey, string[]? statuses, string[]? sortBy, string[]? include) returns InlineResponse20023|error

List alerts for an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

alertKey string? (default ()) - Alert de-duplication key.

statuses string[]? (default ()) - Return only alerts with the given statuses. (More status codes may be introduced in the future.)

sortBy string[]? (default ()) - Used to specify both the field you wish to sort the results on (created_at/resolved_at), as well as the direction (asc/desc) of the results. The sort_by field and direction should be separated by a colon. A maximum of two fields can be included, separated by a comma. Sort direction defaults to ascending.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20023|error - A paginated array of the incident's alerts.

updateIncidentAlerts

Isolated FunctionRemote Function

function updateIncidentAlerts(string accept, string contentType, string id, string 'from, IdAlertsBody payload, int? 'limit, int? offset, boolean total) returns InlineResponse20023|error

Manage alerts

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdAlertsBody -

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20023|error - All of the updates succeeded.

getIncidentAlert

Isolated FunctionRemote Function

function getIncidentAlert(string accept, string contentType, string id, string alertId) returns InlineResponse20024|error

Get an alert

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

alertId string - The id of the alert to retrieve.

Return Type

InlineResponse20024|error - The alert requested.

updateIncidentAlert

Isolated FunctionRemote Function

function updateIncidentAlert(string accept, string contentType, string id, string alertId, string 'from, AlertsAlertIdBody payload) returns AlertsAlertIdBody|error

Update an alert

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

alertId string - The id of the alert to retrieve.

'from string - The email address of a valid user associated with the account making the request.

payload AlertsAlertIdBody - The parameters of the alert to update.

Return Type

AlertsAlertIdBody|error - The alert that was updated.

putIncidentManualBusinessServiceAssociation

Isolated FunctionRemote Function

function putIncidentManualBusinessServiceAssociation(string accept, string id, string businessServiceId, string xEarlyAccess, BusinessServiceIdImpactsBody payload) returns InlineResponse20025|error

Manually change an Incident's Impact on a Business Service.

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

businessServiceId string - The business service ID.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

payload BusinessServiceIdImpactsBody - The impacted relation will cause the Business Service and any Services that it supports to become impacted by this incident.

Return Type

InlineResponse20025|error - OK

getIncidentImpactedBusinessServices

Isolated FunctionRemote Function

function getIncidentImpactedBusinessServices(string accept, string id, string xEarlyAccess) returns InlineResponse20026|error

List Business Services impacted by the given Incident

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access. Do not use this endpoint in production, as it may change!

Return Type

InlineResponse20026|error - OK

listIncidentLogEntries

Isolated FunctionRemote Function

function listIncidentLogEntries(string accept, string contentType, string id, int? 'limit, int? offset, boolean total, string timeZone, string? since, string? until, boolean isOverview, string[]? include) returns InlineResponse20027|error

List log entries for an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

since string? (default ()) - The start of the date range over which you want to search.

until string? (default ()) - The end of the date range over which you want to search.

isOverview boolean (default false) - If true, will return a subset of log entries that show only the most important changes to the incident.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

InlineResponse20027|error - A paginated array of the incident's log entries.

mergeIncidents

Isolated FunctionRemote Function

function mergeIncidents(string accept, string contentType, string id, string 'from, IdMergeBody payload) returns InlineResponse20028|error

Merge incidents

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdMergeBody -

Return Type

InlineResponse20028|error - The target incident, which now contains all the alerts from the source incident.

listIncidentNotes

Isolated FunctionRemote Function

function listIncidentNotes(string accept, string contentType, string id) returns InlineResponse20029|error

List notes for an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20029|error - An array of notes.

createIncidentNote

Isolated FunctionRemote Function

function createIncidentNote(string accept, string contentType, string id, string 'from, IdNotesBody payload) returns InlineResponse20030|error

Create a note on an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdNotesBody -

Return Type

InlineResponse20030|error - The new note.

getOutlierIncident

Isolated FunctionRemote Function

function getOutlierIncident(string accept, string contentType, string id, string? since, string[]? additionalDetails) returns InlineResponse20031|error

Get Outlier Incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

since string? (default ()) - The start of the date range over which you want to search.

additionalDetails string[]? (default ()) - Array of additional attributes to any of the returned incidents for related incidents.

Return Type

InlineResponse20031|error - Outlier Incident information calculated over the same Service as the given Incident.

getPastIncidents

Isolated FunctionRemote Function

function getPastIncidents(string accept, string contentType, string id, int 'limit, boolean total) returns InlineResponse20032|error

Get Past Incidents

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int (default 5) - The number of results to be returned in the response.

total boolean (default false) - By default the total field in the response body is set to null to provide the fastest possible response times. Set total to true for this field to be populated with the total number of Past Incidents.

Return Type

InlineResponse20032|error - OK

listIncidentRelatedChangeEvents

Isolated FunctionRemote Function

function listIncidentRelatedChangeEvents(string id, string accept, string contentType, int? 'limit) returns InlineResponse20033|error

List related Change Events for an Incident

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

Return Type

InlineResponse20033|error - The array of Change Events returned by the query.

getRelatedIncidents

Isolated FunctionRemote Function

function getRelatedIncidents(string accept, string contentType, string id, string[]? additionalDetails) returns InlineResponse20034|error

Get Related Incidents

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

additionalDetails string[]? (default ()) - Array of additional attributes to any of the returned incidents for related incidents.

Return Type

InlineResponse20034|error - A list of Related Incidents and their relationships.

createIncidentResponderRequest

Isolated FunctionRemote Function

function createIncidentResponderRequest(string accept, string contentType, string id, string 'from, IdResponderRequestsBody payload) returns InlineResponse20035|error

Create a responder request for an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdResponderRequestsBody -

Return Type

InlineResponse20035|error - The new responder request for the given incident.

createIncidentSnooze

Isolated FunctionRemote Function

function createIncidentSnooze(string accept, string contentType, string id, string 'from, IdSnoozeBody payload) returns InlineResponse2011|error

Snooze an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdSnoozeBody -

Return Type

InlineResponse2011|error - The incident that was successfully snoozed.

createIncidentStatusUpdate

Isolated FunctionRemote Function

function createIncidentStatusUpdate(string accept, string contentType, string id, string 'from, IdStatusUpdatesBody payload) returns InlineResponse20036|error

Create a status update on an incident

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdStatusUpdatesBody -

Return Type

InlineResponse20036|error - The new status update for the specified incident.

getIncidentNotificationSubscribers

Isolated FunctionRemote Function

function getIncidentNotificationSubscribers(string accept, string id) returns InlineResponse20037|error

List Notification Subscribers

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

InlineResponse20037|error - OK

createIncidentNotificationSubscribers

Isolated FunctionRemote Function

function createIncidentNotificationSubscribers(string accept, string id, StatusUpdatesSubscribersBody payload) returns InlineResponse2009|error

Add Notification Subscribers

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload StatusUpdatesSubscribersBody - The entities to subscribe.

Return Type

InlineResponse2009|error - OK

removeIncidentNotificationSubscribers

Isolated FunctionRemote Function

function removeIncidentNotificationSubscribers(string accept, string id, StatusUpdatesUnsubscribeBody payload) returns InlineResponse20011|error

Remove Notification Subscriber

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload StatusUpdatesUnsubscribeBody - The entities to unsubscribe.

Return Type

InlineResponse20011|error - OK

listLogEntries

Isolated FunctionRemote Function

function listLogEntries(string accept, string contentType, int? 'limit, int? offset, boolean total, string timeZone, string? since, string? until, boolean isOverview, string[]? include, string[]? teamIds) returns InlineResponse20027|error

List log entries

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

since string? (default ()) - The start of the date range over which you want to search.

until string? (default ()) - The end of the date range over which you want to search.

isOverview boolean (default false) - If true, will return a subset of log entries that show only the most important changes to the incident.

include string[]? (default ()) - Array of additional Models to include in response.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Return Type

InlineResponse20027|error - A paginated array of log entries.

getLogEntry

Isolated FunctionRemote Function

function getLogEntry(string accept, string contentType, string id, string timeZone, string[]? include) returns InlineResponse20038|error

Get a log entry

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

InlineResponse20038|error - A single log entry.

updateLogEntryChannel

Isolated FunctionRemote Function

function updateLogEntryChannel(string accept, string contentType, string id, string 'from, IdChannelBody payload) returns Response|error

Update log entry channel information.

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'from string - The email address of a valid user associated with the account making the request.

payload IdChannelBody - The log entry channel to be updated.

Return Type

Response|error - The channel information modification was accepted.

listMaintenanceWindows

Isolated FunctionRemote Function

function listMaintenanceWindows(string accept, string contentType, string? query, int? 'limit, int? offset, boolean total, string[]? teamIds, string[]? serviceIds, string[]? include, string? filter) returns InlineResponse20039|error

List maintenance windows

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

serviceIds string[]? (default ()) - An array of service IDs. Only results related to these services will be returned.

include string[]? (default ()) - Array of additional Models to include in response.

filter string? (default ()) - Only return maintenance windows in a given state.

Return Type

InlineResponse20039|error - A paginated array of maintenance windows.

createMaintenanceWindow

Isolated FunctionRemote Function

function createMaintenanceWindow(string accept, string contentType, string 'from, MaintenanceWindowsBody payload) returns MaintenanceWindowsBody|error

Create a maintenance window

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'from string - The email address of a valid user associated with the account making the request.

payload MaintenanceWindowsBody - The maintenance window object.

Return Type

MaintenanceWindowsBody|error - The maintenance window that was created.

getMaintenanceWindow

Isolated FunctionRemote Function

function getMaintenanceWindow(string accept, string contentType, string id, string[]? include) returns MaintenanceWindowsBody|error

Get a maintenance window

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

MaintenanceWindowsBody|error - The maintenance window that was updated.

updateMaintenanceWindow

Isolated FunctionRemote Function

function updateMaintenanceWindow(string accept, string contentType, string id, MaintenanceWindowsIdBody payload) returns MaintenanceWindowsIdBody|error

Update a maintenance window

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload MaintenanceWindowsIdBody - The maintenance window to be updated.

Return Type

MaintenanceWindowsIdBody|error - The maintenance window that was updated.

deleteMaintenanceWindow

Isolated FunctionRemote Function

function deleteMaintenanceWindow(string accept, string contentType, string id) returns Response|error

Delete or end a maintenance window

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The maintenance window was deleted successfully.

listNotifications

Isolated FunctionRemote Function

function listNotifications(string accept, string contentType, string since, string until, int? 'limit, int? offset, boolean total, string timeZone, string? filter, string[]? include) returns InlineResponse20040|error

List notifications

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

since string - The start of the date range over which you want to search. The time element is optional.

until string - The end of the date range over which you want to search. This should be in the same format as since. The size of the date range must be less than 3 months.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

filter string? (default ()) - Return notification of this type only.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20040|error - A paginated array of notifications.

listOnCalls

Isolated FunctionRemote Function

function listOnCalls(string accept, string contentType, string timeZone, int? 'limit, int? offset, boolean total, string[]? include, string[]? userIds, string[]? escalationPolicyIds, string[]? scheduleIds, string? since, string? until, boolean? earliest) returns InlineResponse20041|error

List all of the on-calls

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

include string[]? (default ()) - Array of additional details to include.

userIds string[]? (default ()) - Filters the results, showing only on-calls for the specified user IDs.

escalationPolicyIds string[]? (default ()) - Filters the results, showing only on-calls for the specified escalation policy IDs.

scheduleIds string[]? (default ()) - Filters the results, showing only on-calls for the specified schedule IDs. If null is provided in the array, it includes permanent on-calls due to direct user escalation targets.

since string? (default ()) - The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. The search range cannot exceed 3 months.

until string? (default ()) - The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. The search range cannot exceed 3 months, and the until time cannot be before the since time.

earliest boolean? (default ()) - This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.

Return Type

InlineResponse20041|error - A paginated array of on-call objects.

listPriorities

Isolated FunctionRemote Function

function listPriorities(string accept, string contentType, int? 'limit, int? offset, boolean total) returns InlineResponse20042|error

List priorities

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20042|error - A paginated array of priorities.

listResponsePlays

Isolated FunctionRemote Function

function listResponsePlays(string accept, string contentType, string? query, boolean? filterForManualRun, string? 'from) returns InlineResponse20043|error

List Response Plays

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

filterForManualRun boolean? (default ()) - When this parameter is present, only those Response Plays that can be run manually will be returned.

'from string? (default ()) - The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.

Return Type

InlineResponse20043|error - The array of Response Plays returned by the query.

createResponsePlay

Isolated FunctionRemote Function

function createResponsePlay(string accept, string contentType, ResponsePlaysBody payload) returns InlineResponse2012|error

Create a Response Play

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ResponsePlaysBody - The Response Play to be created.

Return Type

InlineResponse2012|error - The Response Play that was created.

getResponsePlay

Isolated FunctionRemote Function

function getResponsePlay(string id, string accept, string contentType, string? 'from) returns InlineResponse2012|error

Get a Response Play

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'from string? (default ()) - The email address of a valid user associated with the account making the request. This is optional, and is only used for change tracking.

Return Type

InlineResponse2012|error - The Response Play requested.

updateResponsePlay

Isolated FunctionRemote Function

function updateResponsePlay(string id, string accept, string contentType, ResponsePlaysIdBody payload) returns InlineResponse2012|error

Update a Response Play

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ResponsePlaysIdBody - The Response Play to be updated.

Return Type

InlineResponse2012|error - The Response Play that was updated.

deleteResponsePlay

Isolated FunctionRemote Function

function deleteResponsePlay(string id, string accept, string contentType) returns Response|error

Delete a Response Play

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

Return Type

Response|error - The Response Play was deleted successfully.

runResponsePlay

Isolated FunctionRemote Function

function runResponsePlay(string accept, string contentType, string responsePlayId, string 'from, ResponsePlayIdRunBody payload) returns InlineResponse20044|error

Run a response play

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

responsePlayId string - The response play ID of the response play associated with the request.

'from string - The email address of a valid user associated with the account making the request.

payload ResponsePlayIdRunBody -

Return Type

InlineResponse20044|error - Informs the user if the response play has been run successfully.

listRulesets

Isolated FunctionRemote Function

function listRulesets(string accept, string contentType, int? 'limit, int? offset, boolean total) returns InlineResponse20045|error

List Rulesets

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20045|error - A paginated array of Ruleset objects.

createRuleset

Isolated FunctionRemote Function

function createRuleset(string accept, string contentType, RulesetsBody payload) returns InlineResponse2013|error

Create a Ruleset

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload RulesetsBody -

Return Type

InlineResponse2013|error - The Ruleset that was created.

getRuleset

Isolated FunctionRemote Function

function getRuleset(string accept, string contentType, string id) returns InlineResponse2013|error

Get a Ruleset

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse2013|error - The Ruleset object.

updateRuleset

Isolated FunctionRemote Function

function updateRuleset(string accept, string contentType, string id, RulesetsIdBody payload) returns InlineResponse2013|error

Update a Ruleset

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload RulesetsIdBody -

Return Type

InlineResponse2013|error - The Ruleset that was updated.

deleteRuleset

Isolated FunctionRemote Function

function deleteRuleset(string accept, string contentType, string id) returns Response|error

Delete a Ruleset

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The Ruleset was deleted successfully.

listRulesetEventRules

Isolated FunctionRemote Function

function listRulesetEventRules(string accept, string contentType, string id, int? 'limit, int? offset, boolean total) returns InlineResponse20046|error

List Event Rules

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20046|error - A paginated array of Event Rule objects.

createRulesetEventRule

Isolated FunctionRemote Function

function createRulesetEventRule(string accept, string contentType, string id, IdRulesBody payload) returns InlineResponse2014|error

Create an Event Rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdRulesBody -

Return Type

InlineResponse2014|error - The Event Rule that was created.

getRulesetEventRule

Isolated FunctionRemote Function

function getRulesetEventRule(string accept, string contentType, string id, string ruleId) returns InlineResponse2014|error

Get an Event Rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

Return Type

InlineResponse2014|error - The Event Rule object.

updateRulesetEventRule

Isolated FunctionRemote Function

function updateRulesetEventRule(string accept, string contentType, string id, string ruleId, RulesRuleIdBody payload) returns InlineResponse2014|error

Update an Event Rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

payload RulesRuleIdBody -

Return Type

InlineResponse2014|error - The Event Rule that was updated.

deleteRulesetEventRule

Isolated FunctionRemote Function

function deleteRulesetEventRule(string accept, string contentType, string id, string ruleId) returns Response|error

Delete an Event Rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

Return Type

Response|error - The Event Rule was deleted successfully.

listSchedules

Isolated FunctionRemote Function

function listSchedules(string accept, string contentType, int? 'limit, int? offset, boolean total, string? query, string[]? include) returns InlineResponse20047|error

List schedules

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20047|error - A paginated array of schedule objects.

createSchedule

Isolated FunctionRemote Function

function createSchedule(string accept, string contentType, SchedulesBody payload, boolean overflow) returns SchedulesBody|error

Create a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload SchedulesBody - The schedule to be created.

overflow boolean (default false) - Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Return Type

SchedulesBody|error - The schedule object created.

getSchedule

Isolated FunctionRemote Function

function getSchedule(string accept, string contentType, string id, string timeZone, string? since, string? until) returns SchedulesBody|error

Get a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

since string? (default ()) - The start of the date range over which you want to search.

until string? (default ()) - The end of the date range over which you want to search.

Return Type

SchedulesBody|error - The schedule object.

updateSchedule

Isolated FunctionRemote Function

function updateSchedule(string accept, string contentType, string id, SchedulesIdBody payload, boolean overflow) returns SchedulesIdBody|error

Update a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload SchedulesIdBody - The schedule to be updated.

overflow boolean (default false) - Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Return Type

SchedulesIdBody|error - The updated schedule.

deleteSchedule

Isolated FunctionRemote Function

function deleteSchedule(string accept, string contentType, string id) returns Response|error

Delete a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The schedule was deleted successfully.

listSchedulesAuditRecords

Isolated FunctionRemote Function

function listSchedulesAuditRecords(string accept, string contentType, string id, int? 'limit, string? cursor, string? since, string? until) returns AuditRecordResponseSchema|error

List audit records for a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

listScheduleOverrides

Isolated FunctionRemote Function

function listScheduleOverrides(string accept, string contentType, string id, string since, string until, boolean? editable, boolean? overflow) returns InlineResponse2015|error

List overrides

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

since string - The start of the date range over which you want to search.

until string - The end of the date range over which you want to search.

editable boolean? (default ()) - When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.

overflow boolean? (default ()) - Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.

Return Type

InlineResponse2015|error - The collection of override objects returned by the query.

createScheduleOverride

Isolated FunctionRemote Function

function createScheduleOverride(string accept, string contentType, string id, IdOverridesBody payload) returns InlineResponse2016[]|error

Create one or more overrides

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdOverridesBody - The overrides to be created

Return Type

InlineResponse2016[]|error - A list of overrides requested and a status code indicating whether they were created or rejected

deleteScheduleOverride

Isolated FunctionRemote Function

function deleteScheduleOverride(string accept, string contentType, string id, string overrideId) returns Response|error

Delete an override

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

overrideId string - The override ID on the schedule.

Return Type

Response|error - The override was truncated.

listScheduleUsers

Isolated FunctionRemote Function

function listScheduleUsers(string accept, string contentType, string id, string? since, string? until) returns InlineResponse20048|error

List users on call.

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

since string? (default ()) - The start of the date range over which you want to search.

until string? (default ()) - The end of the date range over which you want to search.

Return Type

InlineResponse20048|error - The users on the given schedule.

createSchedulePreview

Isolated FunctionRemote Function

function createSchedulePreview(string accept, string contentType, SchedulesPreviewBody payload, string? since, string? until, boolean overflow) returns SchedulesPreviewBody|error

Preview a schedule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload SchedulesPreviewBody - The schedule to be previewed.

since string? (default ()) - The start of the date range over which you want to search.

until string? (default ()) - The end of the date range over which you want to search.

overflow boolean (default false) - Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: - If you don't pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. - If you do pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

Return Type

SchedulesPreviewBody|error - What the schedule will look like if posted.

createServiceDependency

Isolated FunctionRemote Function

function createServiceDependency(string accept, string contentType, ServiceDependenciesAssociateBody payload) returns InlineResponse20049|error

Associate service dependencies

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ServiceDependenciesAssociateBody -

Return Type

InlineResponse20049|error - An array of service relationships that were successfully associated.

getBusinessServiceServiceDependencies

Isolated FunctionRemote Function

function getBusinessServiceServiceDependencies(string accept, string contentType, string id) returns InlineResponse20050|error

Get Business Service dependencies

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20050|error - An array of service relationships.

deleteServiceDependency

Isolated FunctionRemote Function

function deleteServiceDependency(string accept, string contentType, ServiceDependenciesDisassociateBody payload) returns InlineResponse20049|error

Disassociate service dependencies

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ServiceDependenciesDisassociateBody -

Return Type

InlineResponse20049|error - An array of service relationships that were successfully disassociated.

getTechnicalServiceServiceDependencies

Isolated FunctionRemote Function

function getTechnicalServiceServiceDependencies(string accept, string contentType, string id) returns InlineResponse20049|error

Get technical service dependencies

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20049|error - An array of service relationships.

listServices

Isolated FunctionRemote Function

function listServices(string accept, string contentType, string? query, int? 'limit, int? offset, boolean total, string[]? teamIds, string timeZone, string sortBy, string[]? include) returns InlineResponse20051|error

List services

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

timeZone string (default "UTC") - Time zone in which dates in the result will be rendered.

sortBy string (default "name") - Used to specify the field you wish to sort the results on.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20051|error - A paginated array of services.

createService

Isolated FunctionRemote Function

function createService(string accept, string contentType, ServicesBody payload) returns ServicesBody|error

Create a service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload ServicesBody - The service to be created

Return Type

ServicesBody|error - The service that was created

getService

Isolated FunctionRemote Function

function getService(string accept, string contentType, string id, string[]? include) returns ServicesBody|error

Get a service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional details to include.

Return Type

ServicesBody|error - The service requested.

updateService

Isolated FunctionRemote Function

function updateService(string accept, string contentType, string id, ServicesIdBody payload) returns ServicesIdBody|error

Update a service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload ServicesIdBody - The service to be updated.

Return Type

ServicesIdBody|error - The service that was updated.

deleteService

Isolated FunctionRemote Function

function deleteService(string accept, string contentType, string id) returns Response|error

Delete a service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The service was deleted successfully.

listServiceAuditRecords

Isolated FunctionRemote Function

function listServiceAuditRecords(string accept, string contentType, string id, int? 'limit, string? cursor, string? since, string? until) returns AuditRecordResponseSchema|error

List audit records for a service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

listServiceChangeEvents

Isolated FunctionRemote Function

function listServiceChangeEvents(string id, string accept, string contentType, string? since, string? until, int? 'limit, int? offset, boolean total, string[]? teamIds, string[]? integrationIds) returns InlineResponse20015|error

List Change Events for a service

Parameters

id string - The ID of the resource.

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

since string? (default ()) - 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? (default ()) - 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 int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

integrationIds string[]? (default ()) - An array of integration IDs. Only results related to these integrations will be returned.

Return Type

InlineResponse20015|error - The array of Change Events returned by the query.

createServiceIntegration

Isolated FunctionRemote Function

function createServiceIntegration(string accept, string contentType, string id, IdIntegrationsBody payload) returns IdIntegrationsBody|error

Create a new integration

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdIntegrationsBody - The integration to be created

Return Type

IdIntegrationsBody|error - The integration that was created.

getServiceIntegration

Isolated FunctionRemote Function

function getServiceIntegration(string accept, string contentType, string id, string integrationId, string[]? include) returns IdIntegrationsBody|error

View an integration

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

integrationId string - The integration ID on the service.

include string[]? (default ()) - Array of additional details to include.

Return Type

IdIntegrationsBody|error - The integration that was requested.

updateServiceIntegration

Isolated FunctionRemote Function

function updateServiceIntegration(string accept, string contentType, string id, string integrationId, IntegrationsIntegrationIdBody payload) returns IntegrationsIntegrationIdBody|error

Update an existing integration

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

integrationId string - The integration ID on the service.

payload IntegrationsIntegrationIdBody - The integration to be updated

Return Type

IntegrationsIntegrationIdBody|error - The integration that was updated.

listServiceEventRules

Isolated FunctionRemote Function

function listServiceEventRules(string accept, string contentType, string id, int? 'limit, int? offset, boolean total) returns InlineResponse20052|error

List Service's Event Rules

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20052|error - A paginated array of Event Rule objects.

createServiceEventRule

Isolated FunctionRemote Function

function createServiceEventRule(string accept, string contentType, string id, IdRulesBody1 payload) returns InlineResponse2017|error

Create an Event Rule on a Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdRulesBody1 -

Return Type

InlineResponse2017|error - The Event Rule that was created.

getServiceEventRule

Isolated FunctionRemote Function

function getServiceEventRule(string accept, string contentType, string id, string ruleId) returns InlineResponse2017|error

Get an Event Rule from a Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

Return Type

InlineResponse2017|error - The Event Rule object.

updateServiceEventRule

Isolated FunctionRemote Function

function updateServiceEventRule(string accept, string contentType, string id, string ruleId, RulesRuleIdBody1 payload) returns InlineResponse2017|error

Update an Event Rule on a Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

payload RulesRuleIdBody1 -

Return Type

InlineResponse2017|error - The Event Rule that was updated.

deleteServiceEventRule

Isolated FunctionRemote Function

function deleteServiceEventRule(string accept, string contentType, string id, string ruleId) returns Response|error

Delete an Event Rule from a Service

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

ruleId string - The id of the Event Rule to retrieve.

Return Type

Response|error - The Event Rule was deleted successfully.

listStatusDashboards

Isolated FunctionRemote Function

function listStatusDashboards(string accept, string xEarlyAccess) returns InlineResponse20053|error

List Status Dashboards

Parameters

accept string - The Accept header is used as a versioning header.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value status-dashboards. Do not use this endpoint in production, as it may change!

Return Type

InlineResponse20053|error - OK

getStatusDashboardById

Isolated FunctionRemote Function

function getStatusDashboardById(string accept, string id, string xEarlyAccess) returns InlineResponse20054|error

Get a single Status Dashboard by id

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value status-dashboards. Do not use this endpoint in production, as it may change!

Return Type

InlineResponse20054|error - OK

getStatusDashboardServiceImpactsById

Isolated FunctionRemote Function

function getStatusDashboardServiceImpactsById(string accept, string id, string xEarlyAccess, string? additionalFields) returns InlineResponse20010|error

Get impacted Business Services for a Status Dashboard by id.

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value status-dashboards. Do not use this endpoint in production, as it may change!

additionalFields string? (default ()) - Provides access to additional fields such as highest priority per business service and total impacted count

Return Type

InlineResponse20010|error - OK

getStatusDashboardByUrlSlug

Isolated FunctionRemote Function

function getStatusDashboardByUrlSlug(string accept, string urlSlug, string xEarlyAccess) returns InlineResponse20054|error

Get a single Status Dashboard by url_slug

Parameters

accept string - The Accept header is used as a versioning header.

urlSlug string - The url_slug for a status dashboard

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value status-dashboards. Do not use this endpoint in production, as it may change!

Return Type

InlineResponse20054|error - OK

getStatusDashboardServiceImpactsByUrlSlug

Isolated FunctionRemote Function

function getStatusDashboardServiceImpactsByUrlSlug(string accept, string urlSlug, string xEarlyAccess, string? additionalFields) returns InlineResponse20010|error

Get impacted Business Services for a Status Dashboard by url_slug

Parameters

accept string - The Accept header is used as a versioning header.

urlSlug string - The url_slug for a status dashboard

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value status-dashboards. Do not use this endpoint in production, as it may change!

additionalFields string? (default ()) - Provides access to additional fields such as highest priority per business service and total impacted count

Return Type

InlineResponse20010|error - OK

Isolated FunctionRemote Function

function listTags(string accept, string contentType, int? 'limit, int? offset, boolean total, string? query) returns InlineResponse200|error

List tags

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

Return Type

InlineResponse200|error - An array of tags names.

createTags

Isolated FunctionRemote Function

function createTags(string accept, string contentType, TagsBody payload) returns TagsBody|error

Create a tag

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload TagsBody -

Return Type

TagsBody|error - The tag that was created.

getTag

Isolated FunctionRemote Function

function getTag(string accept, string contentType, string id) returns TagsBody|error

Get a tag

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

TagsBody|error - The tag requested.

deleteTag

Isolated FunctionRemote Function

function deleteTag(string accept, string contentType, string id) returns Response|error

Delete a tag

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The tag was deleted successfully.

getTagsByEntityType

Isolated FunctionRemote Function

function getTagsByEntityType(string accept, string contentType, string id, string entityType, int? 'limit, int? offset, boolean total) returns InlineResponse20055|error

Get connected entities

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

entityType string - Type of entity related with the tag

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20055|error - An array of connected entities.

listTeams

Isolated FunctionRemote Function

function listTeams(string accept, string contentType, int? 'limit, int? offset, boolean total, string? query) returns InlineResponse20056|error

List teams

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

Return Type

InlineResponse20056|error - A paginated array of teams.

createTeam

Isolated FunctionRemote Function

function createTeam(string accept, string contentType, TeamsBody payload) returns TeamsBody|error

Create a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload TeamsBody - The team to be created.

Return Type

TeamsBody|error - The team that was created.

getTeam

Isolated FunctionRemote Function

function getTeam(string accept, string contentType, string id, string[]? include) returns TeamsBody|error

Get a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

TeamsBody|error - The team requested.

updateTeam

Isolated FunctionRemote Function

function updateTeam(string accept, string contentType, string id, TeamsIdBody payload) returns TeamsIdBody|error

Update a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload TeamsIdBody - The team to be updated.

Return Type

TeamsIdBody|error - The team that was updated.

deleteTeam

Isolated FunctionRemote Function

function deleteTeam(string accept, string contentType, string id, string? reassignmentTeam) returns Response|error

Delete a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

reassignmentTeam string? (default ()) - 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.

Return Type

Response|error - The team was deleted successfully.

listTeamsAuditRecords

Isolated FunctionRemote Function

function listTeamsAuditRecords(string accept, string contentType, string id, int? 'limit, string? cursor, string? since, string? until) returns AuditRecordResponseSchema|error

List audit records for a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

updateTeamEscalationPolicy

Isolated FunctionRemote Function

function updateTeamEscalationPolicy(string accept, string contentType, string id, string escalationPolicyId) returns Response|error

Add an escalation policy to a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

escalationPolicyId string - The escalation policy ID on the team.

Return Type

Response|error - The escalation policy was added to the team.

deleteTeamEscalationPolicy

Isolated FunctionRemote Function

function deleteTeamEscalationPolicy(string accept, string contentType, string id, string escalationPolicyId) returns Response|error

Remove an escalation policy from a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

escalationPolicyId string - The escalation policy ID on the team.

Return Type

Response|error - The escalation policy was removed from the team.

listTeamUsers

Isolated FunctionRemote Function

function listTeamUsers(string accept, string contentType, string id, int? 'limit, int? offset, boolean total, string[]? include) returns InlineResponse20057|error

List members of a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

InlineResponse20057|error - A paginated array of users within the requested team.

getTeamNotificationSubscriptions

Isolated FunctionRemote Function

function getTeamNotificationSubscriptions(string accept, string id) returns InlineResponse20058|error

List Team Notification Subscriptions

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

InlineResponse20058|error - OK

createTeamNotificationSubscriptions

Isolated FunctionRemote Function

function createTeamNotificationSubscriptions(string accept, string id, IdNotificationSubscriptionsBody payload) returns InlineResponse2009|error

Create Team Notification Subscriptions

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload IdNotificationSubscriptionsBody - The entities to subscribe to.

Return Type

InlineResponse2009|error - OK

removeTeamNotificationSubscriptions

Isolated FunctionRemote Function

function removeTeamNotificationSubscriptions(string accept, string id, NotificationSubscriptionsUnsubscribeBody payload) returns InlineResponse20011|error

Unsubscribe the given Team from Notifications on the matching Subscribable entities.

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload NotificationSubscriptionsUnsubscribeBody - The entities to unsubscribe from.

Return Type

InlineResponse20011|error - OK

updateTeamUser

Isolated FunctionRemote Function

function updateTeamUser(string accept, string contentType, string id, string userId, UsersUserIdBody payload) returns Response|error

Add a user to a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

userId string - The user ID on the team.

payload UsersUserIdBody - The role of the user on the team.

Return Type

Response|error - The user was added to the team.

deleteTeamUser

Isolated FunctionRemote Function

function deleteTeamUser(string accept, string contentType, string id, string userId) returns Response|error

Remove a user from a team

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

userId string - The user ID on the team.

Return Type

Response|error - The user was removed to the team.

listUsers

Isolated FunctionRemote Function

function listUsers(string accept, string contentType, string? query, string[]? teamIds, int? 'limit, int? offset, boolean total, string[]? include) returns InlineResponse20059|error

List users

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

query string? (default ()) - Filters the result, showing only the tags whose labels match the query.

teamIds string[]? (default ()) - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

InlineResponse20059|error - A paginated array of users.

createUser

Isolated FunctionRemote Function

function createUser(string accept, string contentType, string 'from, UsersBody payload) returns UsersBody|error

Create a user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'from string - The email address of a valid user associated with the account making the request.

payload UsersBody - The user to be created.

Return Type

UsersBody|error - The user that was created.

getUser

Isolated FunctionRemote Function

function getUser(string accept, string contentType, string id, string[]? include) returns UsersBody|error

Get a user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

UsersBody|error - The user requested.

updateUser

Isolated FunctionRemote Function

function updateUser(string accept, string contentType, string id, UsersIdBody payload) returns UsersIdBody|error

Update a user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload UsersIdBody - The user to be updated.

Return Type

UsersIdBody|error - The user that was updated.

deleteUser

Isolated FunctionRemote Function

function deleteUser(string accept, string contentType, string id) returns Response|error

Delete a user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The user was deleted successfully.

listUsersAuditRecords

Isolated FunctionRemote Function

function listUsersAuditRecords(string accept, string contentType, string id, int? 'limit, string? cursor, string? since, string? until) returns AuditRecordResponseSchema|error

List audit records for a user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'limit int? (default ()) - The minimum of the limit parameter used in the request or the maximum request size of the API.

cursor string? (default ()) - 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 string? (default ()) - The start of the date range over which you want to search. If not specified, defaults to now() - 24 hours (past 24 hours)

until string? (default ()) - The end of the date range over which you want to search. If not specified, defaults to now()

Return Type

AuditRecordResponseSchema|error - Records matching the query criteria.

getUserContactMethods

Isolated FunctionRemote Function

function getUserContactMethods(string accept, string contentType, string id) returns InlineResponse20060|error

List a user's contact methods

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20060|error - A list of contact methods.

createUserContactMethod

Isolated FunctionRemote Function

function createUserContactMethod(string accept, string contentType, string id, IdContactMethodsBody payload) returns InlineResponse2018|error

Create a user contact method

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdContactMethodsBody - The contact method to be created.

Return Type

InlineResponse2018|error - The contact method that was created.

getUserContactMethod

Isolated FunctionRemote Function

function getUserContactMethod(string accept, string contentType, string id, string contactMethodId) returns InlineResponse2018|error

Get a user's contact method

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

contactMethodId string - The contact method ID on the user.

Return Type

InlineResponse2018|error - The user's contact method requested.

updateUserContactMethod

Isolated FunctionRemote Function

function updateUserContactMethod(string accept, string contentType, string id, string contactMethodId, ContactMethodsContactMethodIdBody payload) returns InlineResponse2018|error

Update a user's contact method

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

contactMethodId string - The contact method ID on the user.

payload ContactMethodsContactMethodIdBody - The user's contact method to be updated.

Return Type

InlineResponse2018|error - The user's contact method that was updated.

deleteUserContactMethod

Isolated FunctionRemote Function

function deleteUserContactMethod(string accept, string contentType, string id, string contactMethodId) returns Response|error

Delete a user's contact method

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

contactMethodId string - The contact method ID on the user.

Return Type

Response|error - The contact method was deleted successfully.

getUserNotificationRules

Isolated FunctionRemote Function

function getUserNotificationRules(string accept, string contentType, string id, string[]? include) returns InlineResponse20061|error

List a user's notification rules

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20061|error - A list of notification rules.

createUserNotificationRule

Isolated FunctionRemote Function

function createUserNotificationRule(string accept, string contentType, string id, IdNotificationRulesBody payload) returns IdNotificationRulesBody|error

Create a user notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload IdNotificationRulesBody - The notification rule to be created.

Return Type

IdNotificationRulesBody|error - The notification rule that was created.

getUserNotificationRule

Isolated FunctionRemote Function

function getUserNotificationRule(string accept, string contentType, string id, string notificationRuleId, string[]? include) returns IdNotificationRulesBody|error

Get a user's notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

notificationRuleId string - The notification rule ID on the user.

include string[]? (default ()) - Array of additional details to include.

Return Type

IdNotificationRulesBody|error - The user's notification rule requested.

updateUserNotificationRule

Isolated FunctionRemote Function

function updateUserNotificationRule(string accept, string contentType, string id, string notificationRuleId, NotificationRulesNotificationRuleIdBody payload) returns InlineResponse20062|error

Update a user's notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

notificationRuleId string - The notification rule ID on the user.

payload NotificationRulesNotificationRuleIdBody - The user's notification rule to be updated.

Return Type

InlineResponse20062|error - The user's notification rule that was updated.

deleteUserNotificationRule

Isolated FunctionRemote Function

function deleteUserNotificationRule(string accept, string contentType, string id, string notificationRuleId) returns Response|error

Delete a user's notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

notificationRuleId string - The notification rule ID on the user.

Return Type

Response|error - The notification rule was deleted successfully.

getUserNotificationSubscriptions

Isolated FunctionRemote Function

function getUserNotificationSubscriptions(string accept, string id) returns InlineResponse20058|error

List Notification Subscriptions

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

InlineResponse20058|error - OK

createUserNotificationSubscriptions

Isolated FunctionRemote Function

function createUserNotificationSubscriptions(string accept, string id, IdNotificationSubscriptionsBody1 payload) returns InlineResponse2009|error

Create Notification Subcriptions

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload IdNotificationSubscriptionsBody1 - The entities to subscribe to.

Return Type

InlineResponse2009|error - OK

unsubscribeUserNotificationSubscriptions

Isolated FunctionRemote Function

function unsubscribeUserNotificationSubscriptions(string accept, string id, NotificationSubscriptionsUnsubscribeBody1 payload) returns InlineResponse20011|error

Remove Notification Subscriptions

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

payload NotificationSubscriptionsUnsubscribeBody1 - The entities to unsubscribe from.

Return Type

InlineResponse20011|error - OK

getUserSessions

Isolated FunctionRemote Function

function getUserSessions(string accept, string contentType, string id) returns InlineResponse20063|error

List a user's active sessions

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20063|error - A list of the user's active sessions.

deleteUserSessions

Isolated FunctionRemote Function

function deleteUserSessions(string accept, string contentType, string id) returns Response|error

Delete all user sessions

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

Response|error - The user sessions were all deleted successfully.

getUserSession

Isolated FunctionRemote Function

function getUserSession(string accept, string contentType, string id, string 'type, string sessionId) returns InlineResponse20064|error

Get a user's session

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'type string - The session type for the user session ID.

sessionId string - The session ID for the user.

Return Type

InlineResponse20064|error - The user's session requested.

deleteUserSession

Isolated FunctionRemote Function

function deleteUserSession(string accept, string contentType, string id, string 'type, string sessionId) returns Response|error

Delete a user's session

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

'type string - The session type for the user session ID.

sessionId string - The session ID for the user.

Return Type

Response|error - The user session was deleted successfully.

getUserStatusUpdateNotificationRules

Isolated FunctionRemote Function

function getUserStatusUpdateNotificationRules(string accept, string contentType, string id, string xEarlyAccess, string[]? include) returns InlineResponse20065|error

List a user's status update notification rules

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20065|error - A list of status update notification rules.

createUserStatusUpdateNotificationRule

Isolated FunctionRemote Function

function createUserStatusUpdateNotificationRule(string accept, string contentType, string xEarlyAccess, string id, IdStatusUpdateNotificationRulesBody payload) returns InlineResponse2019|error

Create a user status update notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

id string - The ID of the resource.

payload IdStatusUpdateNotificationRulesBody - The status update notification rule to be created.

Return Type

InlineResponse2019|error - The status update notification rule that was created.

getUserStatusUpdateNotificationRule

Isolated FunctionRemote Function

function getUserStatusUpdateNotificationRule(string accept, string contentType, string xEarlyAccess, string id, string statusUpdateNotificationRuleId, string[]? include) returns InlineResponse20066|error

Get a user's status update notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

id string - The ID of the resource.

statusUpdateNotificationRuleId string - The status update notification rule ID on the user.

include string[]? (default ()) - Array of additional details to include.

Return Type

InlineResponse20066|error - The user's status update notification rule requested.

updateUserStatusUpdateNotificationRule

Isolated FunctionRemote Function

function updateUserStatusUpdateNotificationRule(string accept, string contentType, string xEarlyAccess, string id, string statusUpdateNotificationRuleId, StatusUpdateNotificationRulesStatusUpdateNotificationRuleIdBody payload) returns InlineResponse20067|error

Update a user's status update notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

id string - The ID of the resource.

statusUpdateNotificationRuleId string - The status update notification rule ID on the user.

payload StatusUpdateNotificationRulesStatusUpdateNotificationRuleIdBody - The user's status update notification rule to be updated.

Return Type

InlineResponse20067|error - The user's status update notification rule that was updated.

deleteUserStatusUpdateNotificationRule

Isolated FunctionRemote Function

function deleteUserStatusUpdateNotificationRule(string accept, string contentType, string xEarlyAccess, string id, string statusUpdateNotificationRuleId) returns Response|error

Delete a user's status update notification rule

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

xEarlyAccess string - This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header and the above value. Do not use this endpoint in production, as it may change!

id string - The ID of the resource.

statusUpdateNotificationRuleId string - The status update notification rule ID on the user.

Return Type

Response|error - The status update notification rule was deleted successfully.

getCurrentUser

Isolated FunctionRemote Function

function getCurrentUser(string accept, string contentType, string[]? include) returns UsersIdBody|error

Get the current user

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

include string[]? (default ()) - Array of additional Models to include in response.

Return Type

UsersIdBody|error - The requesting user.

listVendors

Isolated FunctionRemote Function

function listVendors(string accept, string contentType, int? 'limit, int? offset, boolean total) returns InlineResponse20068|error

List vendors

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

Return Type

InlineResponse20068|error - A paginated array of vendors.

getVendor

Isolated FunctionRemote Function

function getVendor(string accept, string contentType, string id) returns InlineResponse20069|error

Get a vendor

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

Return Type

InlineResponse20069|error - The vendor requested

listWebhookSubscriptions

Isolated FunctionRemote Function

function listWebhookSubscriptions(string accept, int? 'limit, int? offset, boolean total, string? filterType, string? filterId) returns InlineResponse20070|error

List webhook subscriptions

Parameters

accept string - The Accept header is used as a versioning header.

'limit int? (default ()) - The number of results per page.

offset int? (default ()) - Offset to start pagination search results.

total boolean (default 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 for more information.

filterType string? (default ()) - The type of resource to filter upon.

filterId string? (default ()) - The id of the resource to filter upon.

Return Type

InlineResponse20070|error - A set of webhook subscriptions matching the request.

createWebhookSubscription

Isolated FunctionRemote Function

function createWebhookSubscription(string accept, string contentType, WebhookSubscriptionsBody payload) returns WebhookSubscriptionsBody|error

Create a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

payload WebhookSubscriptionsBody -

Return Type

WebhookSubscriptionsBody|error - The webhook subscription that was created.

getWebhookSubscription

Isolated FunctionRemote Function

function getWebhookSubscription(string accept, string id) returns WebhookSubscriptionsBody|error

Get a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

WebhookSubscriptionsBody|error - The webhook subscription that was requested.

updateWebhookSubscription

Isolated FunctionRemote Function

function updateWebhookSubscription(string accept, string contentType, string id, WebhookSubscriptionUpdate payload) returns WebhookSubscriptionsBody|error

Update a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

contentType string - Header Content type.

id string - The ID of the resource.

payload WebhookSubscriptionUpdate -

Return Type

WebhookSubscriptionsBody|error - The updated webhook subscription.

deleteWebhookSubscription

Isolated FunctionRemote Function

function deleteWebhookSubscription(string accept, string id) returns Response|error

Delete a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

Response|error - The webhook subscription was deleted successfully.

enableWebhookSubscription

Isolated FunctionRemote Function

function enableWebhookSubscription(string accept, string id) returns WebhookSubscriptionsBody|error

Enable a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

WebhookSubscriptionsBody|error - The webhook subscription that was successfully enabled.

testWebhookSubscription

Isolated FunctionRemote Function

function testWebhookSubscription(string accept, string id) returns Response|error

Test a webhook subscription

Parameters

accept string - The Accept header is used as a versioning header.

id string - The ID of the resource.

Return Type

Response|error - Accepted

Records

pagerduty: Acknowledgement

Fields

at string - Time at which the acknowledgement was created.

acknowledger AcknowledgerReference -

pagerduty: AcknowledgerReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: Action

A message containing information about a single PagerDuty action.

Fields

id? string - Uniquely identifies this outgoing webhook message; can be used for idempotency when processing the messages.

triggered_at? string - The date/time when this message was was sent.

webhook? Webhook - Information about the configured webhook.

pagerduty: Addon

Fields

'type string - The type of Add-on.

name string - The name of the Add-on.

src string - The source URL to display in a frame in the PagerDuty UI. HTTPS is required.

pagerduty: AddonReference

Fields

Fields Included from *Reference

anydata...

src? string - The URL source of the Addon

name? string - The user entered name of the Addon.

'type? string -

pagerduty: AddonsBody

Fields

addon Addon -

pagerduty: AddonsIdBody

Fields

addon Addon -

pagerduty: AgentReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: Alert

Fields

created_at? string - The date/time the alert was first triggered.

'type string - The type of object being created.

status? string - The current status of the alert.

alert_key? string - The alert's de-duplication key.

'service? ServiceReference -

first_trigger_log_entry? LogEntryReference -

incident? IncidentReference -

suppressed boolean(default false) - Whether or not an alert is suppressed. Suppressed alerts are not created with a parent incident.

severity? string - The magnitude of the problem as reported by the monitoring tool.

integration? IntegrationReference -

body? Body - A JSON object containing data describing the alert.

pagerduty: AlertCount

Fields

triggered? int - The count of triggered alerts

resolved? int - The count of resolved alerts

all? int - The total count of alerts

pagerduty: AlertGroupingParameters

Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans.

Fields

'type? string - The type of Alert Grouping. When type is intelligent, config can be omitted.

config? TimeBasedAlertGroupingConfiguration|ContentBasedAlertGroupingConfiguration -

pagerduty: AlertReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: AlertsAlertIdBody

Fields

alert Alert -

pagerduty: AnalyticsIncidentMetrics

Fields

service_id? string - ID of the service. Only included when aggregating by service.

service_name? string - Name of the service. Only included when aggregating by service.

team_id? string - ID of the team.

team_name? string - Name of the team.

mean_seconds_to_resolve? int - Mean time from when an incident was triggered until it was resolved.

mean_seconds_to_first_ack? int - Mean time between the start of an incident, and the first responder to acknowledge.

mean_seconds_to_engage? int - A measure of people response time. This metric measures the time from the first user engagement (acknowledge or responder accept) to the last. This metric is only used for incidents with multiple responders; for incidents with one or no engaged users, this value is null.'

mean_seconds_to_mobilize? int - Mean time between the start of an incident, and the last additional responder to acknowledge. For incidents with one or no engaged users, this value is null.

mean_engaged_seconds? int - Mean engaged time across all responders for incidents that match the given filters. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incidents was snoozed.

mean_engaged_user_count? int - Mean number of users who engaged with an incident. Engaged is defined as acknowledging an incident or accepting a responder request in it.

total_escalation_count? int - Total count of instances where an incident is escalated between responders assigned to an escalation policy.

mean_assignment_count? int - Mean count of instances where an additional responder, who was not on-call for an incident, is added.

total_business_hour_interruptions? int - Total number of unique interruptions during business hours. Business hour: 8am-6pm Mon-Fri, based on the user’s time zone.

total_sleep_hour_interruptions? int - Total number of unique interruptions during sleep hours. Sleep hour: 10pm-8am every day, based on the user’s time zone.

total_off_hour_interruptions? int - Total number of unique interruptions during off hours. Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone.

total_snoozed_seconds? int - Total number of seconds incidents were snoozed.

total_engaged_seconds? int - Total engaged time across all responders for incidents. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incidents was snoozed.'

up_time_pct? decimal - The percentage of time in the defined date range that the service was not interrupted by a major incident.

user_defined_effort_seconds? int - The total response effort in seconds, as defined by the user.

pagerduty: AnalyticsModel

Fields

filters? AnalyticsmodelFilters - Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results

time_zone? string - The time zone to use for the results and grouping.

aggregate_unit? string? - The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period.

pagerduty: AnalyticsmodelFilters

Accepts a set of filters to apply to the Incidents before aggregating. Any incidents that do not match the included filters will be omitted from the results

Fields

created_at_start? string - Accepts an ISO8601 DateTime string. Any incidents with a created_at less than this value will be omitted from the results. The maximum supported time range in conjunction with created_at_end is one year.

created_at_end? string - Accepts an ISO8601 DateTime string. Any incidents with a created_at greater than or equal to this value will be omitted from the results. The maximum supported time range in conjunction with created_at_start is one year.

urgency? string - Any incidents whose urgency does not match the provided string will be omitted from the results.

major? boolean - A boolean flag including whether results should contain only major incidents, or exclude major incidents. If no value is provided all incidents will be included.

team_ids? string[] - An array of team IDs. Only incidents related to these teams will be included in the results. If omitted, all teams the requestor has access to will be included in the results.

service_ids? string[] - An array of service IDs. Only incidents related to these services will be included in the results. If omitted, all services the requestor has access to will be included in the results.

priority_ids? string[] - An array of priority IDs. Only incidents with these priorities will be included in the results. If omitted, all services the requestor has access to will be included in the results.

priority_names? string[] - An array of user-defined priority names. Only incidents with these priorities will be included in the results. If omitted, all services the requestor has access to will be included in the results.

pagerduty: AnalyticsRawIncident

Fields

id? string - Incident Id

team_id? string? - ID of the team the incident was assigned to.

service_id? string - ID of the service that the incident triggered on.

created_at? string - Timestamp of when the incident was created.

resolved_at? string - Timestamp of when the incident was resolved.

urgency? string - Notification level

major? boolean - An incident is classified as a major incident if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.

priority_id? string? - ID of the incident's priority level.

priority_name? string? - The user-provided short name of the priority.

priority_order? int - The integer representation of the incident's priority level.

seconds_to_resolve? int - Time from when incident triggered until it was resolved.

seconds_to_first_ack? int - Time between start of an incident, and the first responder to acknowledge.

seconds_to_engage? int - Time between start of an incident, and the first responder to acknowledge, or to accept responder request.

seconds_to_mobilize? int - Time between start of an incident, and the last additional responder to acknowledge. If an incident has one or less responders, the value will be null.

engaged_seconds? int - Total engaged time across all responders for this incident. Engaged time is measured from the time a user engages with an incident (by acknowledging or accepting a responder request) until the incident is resolved. This may include periods in which the incident was snoozed.

engaged_user_count? int - Total number of users who engaged (acknowledged, accepted responder request) in the incident.

escalation_count? int - Total count of instances where an incident is escalated between responders assigned to an escalation policy.

assignment_count? int - Total count of instances where an additional responder, who was not on-call for the incident, is added.

business_hour_interruptions? int - Total number of unique interruptions during business hour. Business hour: 8am-6pm Mon-Fri, based on the user’s time zone.

sleep_hour_interruptions? int - Total number of unique interruptions during sleep hour. Sleep hour: 10pm-8am every day, based on the user’s time zone.

off_hour_interruptions? int - Total number of unique interruptions during off hour. Off hour: 6pm-10pm Mon-Fri and all day Sat-Sun, based on the user’s time zone.

snoozed_seconds? int - Total seconds the incident has been snoozed for.

pagerduty: AnalyticsrawincidentsFilters

Filters the result, only show incidents that match the conditions passed in the filter.

Fields

created_at_start? string - Filters the result, showing only the incidents where the creation timestamp is greater than the filter value.

created_at_end? string - Filters the result, showing only the incidents where the creation timestamp is less than the filter value.

urgency? string - Filters the result, showing only the incidents where urgency matches the filter value.

major? boolean - An incident is classified as a major incident if it has one of the two highest priorities, or if multiple responders are added and acknowledge the incident.

team_ids? string[] - An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

service_ids? string[] - An array of service IDs. Only results related to these services will be returned.

priority_ids? string[] - The priority_ids filter applied to the results.

priority_names? string[] - The priority_names filter applied to the results.

pagerduty: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

authorization string - The API Key with format Token token=<API_KEY>

pagerduty: AssignLogEntry

Fields

Fields Included from *LogEntry

type string
created_at string
channel Channel
agent AgentReference
note string
contexts Context[]
service ServiceReference
incident IncidentReference
teams TeamReference[]
event_details LogentryEventDetails
anydata...

assignees? UserReference[] - An array of assigned Users for this log entry

'type? string -

pagerduty: Assignment

Fields

at string - Time at which the assignment was created.

assignee UserReference -

pagerduty: AuditMetadata

Fields

messages? string[]? -

pagerduty: AuditRecord

An Audit Trail record

Fields

id string -

self? string? - Record URL.

execution_time string - The date/time the action executed, in ISO8601 format and millisecond precision.

execution_context? AuditrecordExecutionContext? - Action execution context

actors? Reference[]? -

method AuditrecordMethod - The method information

root_resource Reference -

action string -

details? AuditrecordDetails? - Additional details to provide further information about the action or the resource that has been audited.

pagerduty: AuditrecordDetails

Additional details to provide further information about the action or the resource that has been audited.

Fields

'resource Reference -

fields? AuditrecordDetailsFields[]? - A set of fields that have been affected. The fields that have not been affected MAY be returned.

references? AuditrecordDetailsReferences[]? - A set of references that have been affected.

pagerduty: AuditrecordDetailsFields

Information about the affected field. When available, field's before and after values are returned:

Resource creation

value MAY be returned

Resource update

value MAY be returned
before_value MAY be returned

Resource deletion

before_value MAY be returned

Fields

name string - Name of the resource field

description? string? - Human readable description of the resource field

value? string? - new or updated value of the field

before_value? string? - previous or deleted value of the field

pagerduty: AuditrecordDetailsReferences

Fields

name string - Name of the reference field

description? string? - Human readable description of the references field

added? Reference[]? -

removed? Reference[]? -

pagerduty: AuditrecordExecutionContext

Action execution context

Fields

request_id? string? - Request Id

remote_address? string? - remote address

pagerduty: AuditrecordMethod

The method information

Fields

description? string? -

truncated_token? string? - Truncated token containing the last 4 chars of the token's actual value.

'type string - Describes the method used to perform the action: browser -- authenticated user session. Session value is not returned in the truncated_token field. oauth -- access token obtained via the OAuth flow. Truncated token value is returned in the truncated_token field. api_token -- Pagerduty API token. Truncated token value is returned in the truncated_token field. identity_provider -- action performed by an Identity provider on behalf of a user. No value is returned in the truncated_token field. other -- Method that does not fall in the predefined categories. Truncated token value MAY be returned in the truncated_token field.

pagerduty: AuditRecordResponseSchema

Fields

records AuditRecord[] -

response_metadata? AuditMetadata? -

Fields Included from *CursorPagination

limit int
next_cursor string|()
anydata...

pagerduty: Body

A JSON object containing data describing the alert.

Fields

'type? string - The type of the body.

contexts? Context[] - Contexts to be included with the body such as links to graphs or images.

details? record {} - An arbitrary JSON object containing any data explaining the nature of the alert.

pagerduty: BusinessService

Fields

name? string - The name of the business service.

description? string - The user-provided description of the business service.

point_of_contact? string - The point of contact assigned to this service.

team? Team3? - Reference to the team that owns the business service.

pagerduty: BusinessServiceIdImpactsBody

Fields

relation string -

pagerduty: BusinessServiceReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: BusinessServicesBody

Fields

business_service? BusinessServicesBusinessService - The Business Service to be created

pagerduty: BusinessServicesBusinessService

The Business Service to be created

Fields

name? string - The name of the Business Service.

description? string - The description of the Business Service.

point_of_contact? string - The owner of the Business Service.

team? Team1 - Reference to the team that owns the Business Service.

pagerduty: BusinessServicesIdBody

Fields

business_service? BusinessServicesidBusinessService - The Business Service to be created

pagerduty: BusinessServicesidBusinessService

The Business Service to be created

Fields

name? string - The name of the Business Service.

description? string - The description of the Business Service.

point_of_contact? string - The owner of the Business Service.

team? Team2 - Reference to the team that owns the Business Service.

pagerduty: BusinessServicesPriorityThresholdsBody

Fields

global_threshold BusinessServicespriorityThresholdsGlobalThreshold -

pagerduty: BusinessServicespriorityThresholdsGlobalThreshold

Fields

id string -

'order decimal -

pagerduty: ChangeEvent

Fields

timestamp? string - The time at which the emitting tool detected or generated the event.

'type? string - The type of object being created.

services? ServiceReference[] - An array containing Service objects that this change event is associated with.

integration? record {} -

routing_key? string - This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events.

summary? string - A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters.

'source? string - The unique name of the location where the Change Event occurred.

links? ChangeeventLinks[] - List of links to include.

images? ChangeeventImages[] -

custom_details? record {} - Additional details about the change event.

pagerduty: ChangeeventImages

Fields

src? string -

href? string -

alt? string -

pagerduty: ChangeeventLinks

Fields

href? string -

text? string -

pagerduty: ChangeEventsIdBody

Fields

change_event ChangeEvent -

pagerduty: Channel

Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of auto, email, api, nagios, or timeout if agent[type] is service. Will be one of email, sms, website, web_trigger, or note if agent[type] is user. See below for detailed information about channel formats.

Fields

'type string - type

user? record {} - user

team? record {} - team

channel? record {} - channel

pagerduty: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

pagerduty: ConferenceBridge

Fields

conference_number? string - The phone number of the conference call for the conference bridge. Phone numbers should be formatted like +1 415-555-1212,,,,1234#, where a comma (,) represents a one-second wait and pound (#) completes access code input.

conference_url? string - An URL for the conference bridge. This could be a link to a web conference or Slack channel.

pagerduty: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

pagerduty: ContactMethod

Fields

'type string - The type of contact method being created.

label string - The label (e.g., "Work", "Mobile", etc.).

address string - The "address" to deliver to: email, phone number, etc., depending on the type.

pagerduty: ContactMethodReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: ContactMethodsContactMethodIdBody

Fields

contact_method PhoneContactMethod|PushContactMethod|EmailContactMethod -

pagerduty: ContentBasedAlertGroupingConfiguration

The configuration for Content Based Alert Grouping

Fields

aggregate? string - Whether Alerts should be grouped if all or any specified fields match. If all is selected, an exact match on every specified field name must occur for Alerts to be grouped. If any is selected, Alerts will be grouped when there is an exact match on at least one of the specified fields.

fields? string[] - The fields with which to group against. Depending on the aggregate, Alerts will group if some or all the fields match

pagerduty: Context

Fields

'type string - The type of context being attached to the incident.

href? string - The link's target url

src? string - The image's source url

text? string - The alternate display for an image

pagerduty: CursorPagination

Fields

'limit int - The minimum of the limit parameter used in the request or the maximum request size of the API.

next_cursor string? - An opaque string than will deliver the next set of results when provided as the cursor parameter in a subsequent request. A null value for this field indicates that there are no additional results.

pagerduty: EmailContactMethod

The Email Contact Method of the User.

Fields

Fields Included from *ContactMethod

type string
label string
address string
anydata...

'type? string -

send_short_email? boolean - Send an abbreviated email message instead of the standard email output. Useful for email-to-SMS gateways and email based pagers.

pagerduty: EmailParser

Fields

action string -

match_predicate MatchPredicate -

value_extractors? EmailparserValueExtractors[] - Additional values that will be pulled in to the Incident object. Exactly one value extractor must have a value_name of incident_key.

pagerduty: EmailparserValueExtractors

Fields

'type string -

part string -

value_name string - The field name to set in the Incident object. Exactly one must use the value_name of incident_key

regex? string -

starts_after? string -

ends_with? string -

pagerduty: EntityReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: EntityTypeidchangeTagsRemove

Fields

'type string -

id string - The id of the tag

pagerduty: EscalateLogEntry

Fields

Fields Included from *LogEntry

type string
created_at string
channel Channel
agent AgentReference
note string
contexts Context[]
service ServiceReference
incident IncidentReference
teams TeamReference[]
event_details LogentryEventDetails
anydata...

assignees? UserReference[] - An array of assigned Users for this log entry

'type? string -

pagerduty: EscalationPoliciesBody

Fields

escalation_policy EscalationPolicy -

pagerduty: EscalationPoliciesIdBody

Fields

escalation_policy EscalationPolicy -

pagerduty: EscalationPolicy

Fields

'type string - The type of object being created.

name string - The name of the escalation policy.

description? string - Escalation policy description.

num_loops int(default 0) - The number of times the escalation policy will repeat after reaching the end of its escalation.

on_call_handoff_notifications? string - Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services".

escalation_rules EscalationRule[] -

services? ServiceReference[] -

teams? TeamReference[] - Teams associated with the policy. Account must have the teams ability to use this parameter.

pagerduty: EscalationPolicyReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: EscalationRule

Fields

id? string -

escalation_delay_in_minutes int - The number of minutes before an unacknowledged incident escalates away from this rule.

targets EscalationTargetReference[] - The targets an incident should be assigned to upon reaching this rule.

pagerduty: EscalationTargetReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: EventRule

Fields

id? string - ID of the Event Rule.

self? string - the API show URL at which the object is accessible.

disabled? boolean - Indicates whether the Event Rule is disabled and would therefore not be evaluated.

conditions? EventruleConditions - Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.

time_frame? EventruleTimeFrame - Time-based conditions for limiting when the rule is active.

variables? EventruleVariables[] - [Early Access] Populate variables from event payloads and use those variables in other event actions.

position? int - Position/index of the Event Rule in the Ruleset. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching rule is found.

catch_all? boolean - Indicates whether the Event Rule is the last Event Rule of the Ruleset that serves as a catch-all. It has limited functionality compared to other rules and always matches.

actions? record { route record { value string } } - When an event matches this rule, the actions that will be taken to change the resulting alert and incident.

pagerduty: EventRuleActionsCommon

When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.

Fields

annotate? EventruleactionscommonAnnotate? - Set a note on the resulting incident.

event_action? EventruleactionscommonEventAction? - Set whether the resulting alert status is trigger or resolve.

extractions? (record { target string, 'source string, regex string }|record { target string, template string })[] - Dynamically extract values to set and modify new and existing PD-CEF fields.

priority? EventruleactionscommonPriority? - Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.

severity? EventruleactionscommonSeverity? - Set the severity of the resulting alert.

suppress? EventruleactionscommonSuppress - Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.

suspend? EventruleactionscommonSuspend? - Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action

pagerduty: EventruleactionscommonAnnotate

Set a note on the resulting incident.

Fields

value string - The content of the note.

pagerduty: EventruleactionscommonEventAction

Set whether the resulting alert status is trigger or resolve.

Fields

value string -

pagerduty: EventruleactionscommonPriority

Set the priority ID for the resulting incident. You can find the priority you want by calling the priorities endpoint.

Fields

value string - The priority ID.

pagerduty: EventruleactionscommonSeverity

Set the severity of the resulting alert.

Fields

value string -

pagerduty: EventruleactionscommonSuppress

Set whether the resulting alert is suppressed. Can optionally be used with a threshold where resulting alerts will be suppressed until the threshold is met in a window of time. If using a threshold the rule must also set a route action.

Fields

value boolean -

threshold_value? int - The number of occurences needed during the window of time to trigger the theshold.

threshold_time_unit? string - The time unit for the window of time.

threshold_time_amount? int - The amount of time units for the window of time.

pagerduty: EventruleactionscommonSuspend

Set the length of time to suspend the resulting alert before triggering. Rules with a suspend action must also set a route action, and cannot have a suppress with threshold action

Fields

value int - The amount of time to suspend the alert in seconds.

pagerduty: EventruleConditions

Conditions evaluated to check if an event matches this Event Rule. Is always empty for the catch_all rule, though.

Fields

operator string - Operator to combine sub-conditions.

subconditions EventruleConditionsSubconditions[] - Array of sub-conditions.

pagerduty: EventruleConditionsParameters

Fields

path string - Path to a field in an event, in dot-notation. For Event Rules on a serivce, this will have to be a PD-CEF field.

value string - Value to apply to the operator.

options? record {} - Options to configure the operator.

pagerduty: EventruleConditionsSubconditions

Fields

operator string - The type of operator to apply.

parameters EventruleConditionsParameters -

pagerduty: EventruleParameters

The parameters for performing the operation to populate the

Fields

value string - The value for the operation. For example, an RE2 regular expression for regex-type variables.

path string - Path to a field in an event, in dot-notation. For Event Rules on a Service, this will have to be a PD-CEF field.

pagerduty: EventruleTimeFrame

Time-based conditions for limiting when the rule is active.

Fields

active_between? EventruleTimeFrameActiveBetween - A fixed window of time during which the rule is active.

scheduled_weekly? EventruleTimeFrameScheduledWeekly - A reccuring window of time based on the day of the week, during which the rule is active.

pagerduty: EventruleTimeFrameActiveBetween

A fixed window of time during which the rule is active.

Fields

start_time int - The start time in milliseconds.

end_time int - End time in milliseconds.

pagerduty: EventruleTimeFrameScheduledWeekly

A reccuring window of time based on the day of the week, during which the rule is active.

Fields

start_time int - The amount of milliseconds into the day at which the window starts.

duration int - The duration of the window in milliseconds.

timezone string - The timezone.

weekdays int[] - An array of day values. Ex [1, 3, 5] is Monday, Wednesday, Friday.

pagerduty: EventruleVariables

Fields

'type string - The type of operation to populate the variable.

name string - The name of the variable.

parameters EventruleParameters - The parameters for performing the operation to populate the

pagerduty: Extension

Fields

name string - The name of the extension.

'type string(default "extension") - The type of object being created.

endpoint_url? string - The url of the extension.

extension_objects ServiceReference[] - The objects for which the extension applies

extension_schema ExtensionSchemaReference -

temporarily_disabled boolean(default false) - Whether or not this extension is temporarily disabled; for example, a webhook extension that is repeatedly rejected by the server.

config? record {} - The object that contains extension configuration values depending on the extension schema specification.

pagerduty: ExtensionReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: ExtensionsBody

Fields

extension Extension -

pagerduty: ExtensionSchema

Fields

icon_url? string - A small logo, 18-by-18 pixels.

logo_url? string - A large logo, 75 pixels high and no more than 300 pixels wide.

label? string - Human friendly display label

'key? string - Machine friendly display label

description? string - The long description for the Extension

guide_url? string - A link to the extension's support guide

send_types? string[] - The types of PagerDuty incident events that will activate this Extension

url? string - The url that the webhook payload will be sent to for this Extension.

pagerduty: ExtensionSchemaReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: ExtensionsIdBody

Fields

extension Extension -

pagerduty: IdAlertsBody

Fields

alerts Alert[] - An array of alerts, including the parameters to update for each alert.

pagerduty: IdChangeTagsBody

Tags to add to or remove from the entity.

Fields

add? TagsToAdd[] - Array of tags and/or tag references to add to the entity. For elements with type tag_reference, the tag with the corresponding id is added to the entity. For elements with type tag, if there is an existing tag with the given label that tag is added to the entity. If there is no existing tag with that label and the user has permission to create tags, a new tag is created with that label and assigned to the entity.

remove? EntityTypeidchangeTagsRemove[] - Array of tag references to remove from the entity.

pagerduty: IdChannelBody

Fields

channel LogEntriesidchannelChannel - The parameters to update.

pagerduty: IdContactMethodsBody

Fields

contact_method PhoneContactMethod|PushContactMethod|EmailContactMethod -

pagerduty: IdIntegrationsBody

Fields

integration Integration -

pagerduty: IdMergeBody

Fields

source_incidents IncidentReference[] - The source incidents that will be merged into the target incident and resolved.

pagerduty: IdNotesBody

Fields

note IncidentsidnotesNote -

pagerduty: IdNotificationRulesBody

Fields

notification_rule NotificationRule -

pagerduty: IdNotificationSubscriptionsBody

Fields

subscribables NotificationSubscribable[] -

pagerduty: IdNotificationSubscriptionsBody1

Fields

subscribables NotificationSubscribable[] -

pagerduty: IdOverridesBody

Fields

overrides? Override[] -

pagerduty: IdResponderRequestsBody

Fields

requester_id string - The user id of the requester.

message string - The message sent with the responder request.

responder_request_targets ResponderRequestTargetReference[] - The array of targets the responder request is sent to.

pagerduty: IdRulesBody

Fields

rule EventRule -

pagerduty: IdRulesBody1

Fields

rule ServiceEventRule -

pagerduty: IdSnoozeBody

Fields

duration int - The number of seconds to snooze the incident for. After this number of seconds has elapsed, the incident will return to the "triggered" state.

pagerduty: IdStatusUpdateNotificationRulesBody

Fields

status_update_notification_rule StatusUpdateNotificationRule - A rule for contacting the user for Incident Status Updates.

pagerduty: IdStatusUpdatesBody

Fields

message string - The message to be posted as a status update.

pagerduty: IdSubscribersBody

Fields

subscribers NotificationSubscriber[] -

pagerduty: IdUnsubscribeBody

Fields

subscribers NotificationSubscriber[] -

pagerduty: Impact

Fields

id? string -

name? string -

'type? string - The kind of object that has been impacted

status? string - The current impact status of the object

additional_fields? ImpactAdditionalFields -

pagerduty: ImpactAdditionalFields

Fields

highest_impacting_priority? ImpactAdditionalFieldsHighestImpactingPriority? - Priority information for the highest priority level that is affecting the impacted object.

pagerduty: ImpactAdditionalFieldsHighestImpactingPriority

Priority information for the highest priority level that is affecting the impacted object.

Fields

id? string -

'order? int -

pagerduty: Impactor

Fields

id? string -

'type? string - The kind of object that is impacting

pagerduty: Incident

Fields

incident_number? int - The number of the incident. This is unique across your account.

created_at? string - The date/time the incident was first triggered.

status? string - The current status of the incident.

title? string - A succinct description of the nature, symptoms, cause, or effect of the incident.

pending_actions? IncidentAction[] - The list of pending_actions on the incident. A pending_action object contains a type of action which can be escalate, unacknowledge, resolve or urgency_change. A pending_action object contains at, the time at which the action will take place. An urgency_change pending_action will contain to, the urgency that the incident will change to.

incident_key? string - The incident's de-duplication key.

'service? ServiceReference -

assignments? Assignment[] - List of all assignments for this incident. This list will be empty if the Incident.status is resolved.

assigned_via? string - How the current incident assignments were decided. Note that direct_assignment incidents will not escalate up the attached escalation_policy

acknowledgements? Acknowledgement[] - List of all acknowledgements for this incident. This list will be empty if the Incident.status is resolved or triggered.

last_status_change_at? string - The time at which the status of the incident last changed.

last_status_change_by? AgentReference -

first_trigger_log_entry? LogEntryReference -

escalation_policy? EscalationPolicyReference -

teams? TeamReference[] - The teams involved in the incident’s lifecycle.

priority? PriorityReference -

urgency? string - The current urgency of the incident.

resolve_reason? ResolveReason -

alert_counts? AlertCount -

conference_bridge? ConferenceBridge -

body? IncidentBody -

occurrence? IncidentOccurrence -

pagerduty: IncidentAction

An incident action is a pending change to an incident that will automatically happen at some future time.

Fields

'type string -

at string -

pagerduty: IncidentAddon

Fields

Fields Included from *Addon

type string
name string
src string
anydata...

services? ServiceReference[] - The services this Add-on is associated with. If non-empty, the Add-on will appear only on incidents for those services. If empty, it will appear on incidents for all services.

pagerduty: IncidentBody

Fields

'type string -

details? string - Additional incident details.

pagerduty: IncidentNote

Fields

id? string -

user? record { 'type string } -

channel? IncidentnoteChannel - The means by which this Note was created. Has different formats depending on type.

content string - The note content

created_at? string - The time at which the note was submitted

pagerduty: IncidentnoteChannel

The means by which this Note was created. Has different formats depending on type.

Fields

summary string - A string describing the source of the Note.

id? string -

'type? string - A string that determines the schema of the object

self? string - The API show URL at which the object is accessible

html_url? string - a URL at which the entity is uniquely displayed in the Web app

pagerduty: IncidentOccurrence

Fields

count? int - The ID of the Service referenced.

frequency? decimal - The percentage that this kind of Incident has occurred on this Service over the given period of time.

category? string - The classifcation of the Outlier Incident. The values can be one of ["novel", "rare", "frequent", "other"]. "novel": It means this Incident hasn't occured. "rare": It means this Incident occurs with a low frequency. "frequent": It means this Incident occurs with a high frequency. "other": It means this Incident occurs with a medium frequency.

since? string - The start of the date/time range over which Outlier Incident was calculated.

until? string - The end of the date/time range over which Outlier Incident was calculated.

pagerduty: IncidentReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: IncidentsAssignments

Fields

assignee? UserReference -

pagerduty: IncidentsBody

Fields

incidents IncidentsIncidents[] - An array of incidents, including the parameters to update.

pagerduty: IncidentsBody1

Fields

incident IncidentsIncident - Details of the incident to be created.

pagerduty: IncidentsIdBody

Fields

incident IncidentsidIncident - The parameters of the incident to update.

pagerduty: IncidentsidIncident

The parameters of the incident to update.

Fields

'type string - The incident type.

status? string - The new status of the incident.

priority? PriorityReference -

resolution? string - The resolution for this incident if status is set to resolved.

title? string - The new title of the incident.

escalation_level? int - Escalate the incident to this level in the escalation policy.

assignments? IncidentsAssignments[] - Assign the incident to these assignees.

escalation_policy? EscalationPolicyReference -

urgency? string - The urgency of the incident.

conference_bridge? ConferenceBridge -

pagerduty: IncidentsidnotesNote

Fields

content string - The note content

pagerduty: IncidentsIncident

Details of the incident to be created.

Fields

'type string -

title string - A succinct description of the nature, symptoms, cause, or effect of the incident.

'service ServiceReference -

priority? PriorityReference -

urgency? string - The urgency of the incident

body? IncidentBody -

incident_key? string - A string which identifies the incident. Sending subsequent requests referencing the same service and with the same incident_key will result in those requests being rejected if an open incident matches that incident_key.

assignments? IncidentsAssignments[] - Assign the incident to these assignees. Cannot be specified if an escalation policy is given.

escalation_policy? EscalationPolicyReference -

conference_bridge? ConferenceBridge -

pagerduty: IncidentsIncidents

Fields

id string - The id of the incident to update.

'type string - The incident type.

status? string - The new status of the incident.

resolution? string - The resolution for this incident if status is set to resolved.

title? string - A succinct description of the nature, symptoms, cause, or effect of the incident.

priority? PriorityReference -

escalation_level? int - Escalate the incident to this level in the escalation policy.

assignments? IncidentsAssignments[] - Assign the incident to these assignees.

escalation_policy? EscalationPolicyReference -

conference_bridge? ConferenceBridge -

pagerduty: IncidentsRespondersReference

Fields

state? string - The status of the responder being added to the incident

user? UserReference -

incident? IncidentReference -

updated_at? string -

message? string - The message sent with the responder request

requester? UserReference -

requested_at? string -

pagerduty: IncidentUrgencyRule

Fields

Fields Included from *IncidentUrgencyType

type string
urgency string
anydata...

during_support_hours? IncidentUrgencyType -

outside_support_hours? IncidentUrgencyType -

pagerduty: IncidentUrgencyType

Fields

'type? string - The type of incident urgency: whether it's constant, or it's dependent on the support hours.

urgency? string - The incidents' urgency, if type is constant.

pagerduty: InlineResponse200

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

tags Tag[] -

pagerduty: InlineResponse2001

Fields

abilities string[] - The set of abilities your account has.

pagerduty: InlineResponse20010

Fields

Fields Included from *LiveListResponse

limit int
more boolean
anydata...

services? Impact[] -

additional_fields? InlineResponse20010AdditionalFields -

pagerduty: InlineResponse20010AdditionalFields

Fields

total_impacted_count? int -

pagerduty: InlineResponse20011

Fields

deleted_count decimal -

unauthorized_count decimal -

non_existent_count decimal -

pagerduty: InlineResponse20012

Fields

Fields Included from *LiveListResponse

limit int
more boolean
anydata...

impactors? Impactor[] -

pagerduty: InlineResponse20013

Fields

global_threshold? InlineResponse20013GlobalThreshold? -

pagerduty: InlineResponse20013GlobalThreshold

Fields

id? string -

'order? int -

pagerduty: InlineResponse20014

Fields

global_threshold InlineResponse20014GlobalThreshold -

pagerduty: InlineResponse20014GlobalThreshold

Fields

id string -

'order decimal -

pagerduty: InlineResponse20015

Fields

change_events? ChangeEvent[] -

pagerduty: InlineResponse20016

Fields

change_event? ChangeEvent -

pagerduty: InlineResponse20017

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

escalation_policies EscalationPolicy[] -

pagerduty: InlineResponse20018

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

extension_schemas ExtensionSchema[] -

pagerduty: InlineResponse20019

Fields

extension_schema ExtensionSchema -

pagerduty: InlineResponse2002

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

addons AddonReference[] -

pagerduty: InlineResponse20020

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

extensions Extension[] -

pagerduty: InlineResponse20021

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

incidents Incident[] -

pagerduty: InlineResponse20022

Fields

incident Incident -

pagerduty: InlineResponse20023

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

alerts Alert[] -

pagerduty: InlineResponse20024

Fields

alert Alert -

pagerduty: InlineResponse20025

Fields

relation? string -

pagerduty: InlineResponse20026

Fields

Fields Included from *CursorPagination

limit int
next_cursor string|()
anydata...

services? Impact[] -

pagerduty: InlineResponse20027

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

log_entries LogEntry[] -

pagerduty: InlineResponse20028

Fields

incident IncidentReference -

pagerduty: InlineResponse20029

Fields

notes IncidentNote[] -

pagerduty: InlineResponse2003

Fields

data? AnalyticsIncidentMetrics[] -

Fields Included from *AnalyticsModel

filters AnalyticsmodelFilters
time_zone string
aggregate_unit string|()
anydata...

pagerduty: InlineResponse20030

Fields

note IncidentNote -

pagerduty: InlineResponse20031

Fields

outlier_incident? InlineResponse20031OutlierIncident - Outlier Incident information calculated over the same Service as the given Incident.

pagerduty: InlineResponse20031OutlierIncident

Outlier Incident information calculated over the same Service as the given Incident.

Fields

incident? Incident -

incident_template? InlineResponse20031OutlierIncidentIncidentTemplate -

pagerduty: InlineResponse20031OutlierIncidentIncidentTemplate

Fields

id? string -

cluster_id? string - The cluster the Incident Template pattern belongs to

mined_text? string - The Incident Template mined pattern text

pagerduty: InlineResponse20032

Fields

past_incidents? InlineResponse20032PastIncidents[] - Aggregate of past incidents

total? decimal - The total number of Past Incidents if the total parameter was set in the request

'limit? decimal - The maximum number of Incidents requested

pagerduty: InlineResponse20032Incident

Incident model reference

Fields

id? string - The globally unique identifier of the incident

created_at? string - The date/time the incident was first triggered

self? string - The URL at which the object is accessible

title? string - The description of the nature, symptoms, cause, or effect of the incident

pagerduty: InlineResponse20032PastIncidents

Fields

incident? InlineResponse20032Incident - Incident model reference

score? decimal - The computed similarity score associated with the incident and parent incident

pagerduty: InlineResponse20033

Fields

change_events? record { correlation_reason record { reason string } }[] -

pagerduty: InlineResponse20034

Fields

related_incidents? InlineResponse20034RelatedIncidents[] - A list of Related Incidents and their relationships.

pagerduty: InlineResponse20034RelatedIncidents

Fields

incident? Incident -

relationships? InlineResponse20034Relationships[] - A list of reasons for why the Incident is considered related.

pagerduty: InlineResponse20034Relationships

Fields

'type? string - The type of relationship. A relationship outlines the reason why two Incidents are considered related.

metadata? RelatedIncidentMachineLearningRelationship|RelatedIncidentServiceDependencyRelationship -

pagerduty: InlineResponse20035

Fields

responder_request ResponderRequest -

pagerduty: InlineResponse20036

Fields

status_update StatusUpdate -

pagerduty: InlineResponse20037

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

subscribers? NotificationSubscriberWithContext[] -

account_id? string - The ID of the account belonging to the subscriber entity

pagerduty: InlineResponse20038

Fields

log_entry LogEntry -

pagerduty: InlineResponse20039

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

maintenance_windows MaintenanceWindow[] -

pagerduty: InlineResponse2004

Fields

first string - Cursor to identify the first object in the response.

last string - Cursor to identify the last object in the response.

'limit int - Number of results to include in the batch.

more boolean - Indicates if there are more resources available than were returned.

'order string - The order in which the results were sorted; asc for ascending, desc for descending.

order_by string - The column that was used for ordering the results.

filters? InlineResponse2004Filters - A collection of filters that were applied to the results.

time_zone string - The time zone that the results are in.

data AnalyticsRawIncident[] -

pagerduty: InlineResponse20040

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

notifications Notification[] -

pagerduty: InlineResponse20041

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

oncalls Oncall[] -

pagerduty: InlineResponse20042

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

priorities Priority[] -

pagerduty: InlineResponse20043

Fields

response_plays? ResponsePlay[] -

pagerduty: InlineResponse20044

Fields

status string -

pagerduty: InlineResponse20045

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

rulesets? Ruleset[] -

pagerduty: InlineResponse20046

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

rules? EventRule[] - The paginated list of rules of the Ruleset.

pagerduty: InlineResponse20047

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

schedules Schedule[] -

pagerduty: InlineResponse20048

Fields

users User[] -

pagerduty: InlineResponse20049

Fields

relationships? InlineResponse20049Relationships[] - List of all the technical service's dependencies

pagerduty: InlineResponse20049DependentService

The reference to the service that is dependent on the technical service.

Fields

id? string -

'type? string -

pagerduty: InlineResponse20049Relationships

Fields

supporting_service? InlineResponse20049SupportingService - The reference to the service that supports the technical service.

dependent_service? InlineResponse20049DependentService - The reference to the service that is dependent on the technical service.

id? string -

'type? string -

pagerduty: InlineResponse20049SupportingService

The reference to the service that supports the technical service.

Fields

id? string -

'type? string -

pagerduty: InlineResponse2004Filters

A collection of filters that were applied to the results.

Fields

created_at_start? string - The lower boundary for the created_at range filter applied to the results.

created_at_end? string - The upper boundary for the created_at range filter applied to the results.

urgency? string - The urgency filter applied to the results.

major? boolean - The major incident filter applied to the results.

team_ids? string[] - The team_ids filter applied to the results.

service_ids? string[] - The service_ids filter applied to the results.

priority_ids? string[] - The priority_ids filter applied to the results.

priority_names? string[] - The priority_names filter applied to the results.

pagerduty: InlineResponse2005

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

business_services BusinessService[] -

pagerduty: InlineResponse20050

Fields

relationships? InlineResponse20050Relationships[] - List of all the Business Service's dependencies.

pagerduty: InlineResponse20050DependentService

The reference to the service that is dependent on the Business Service.

Fields

id? string -

'type? string -

pagerduty: InlineResponse20050Relationships

Fields

supporting_service? InlineResponse20050SupportingService - The reference to the service that supports the Business Service.

dependent_service? InlineResponse20050DependentService - The reference to the service that is dependent on the Business Service.

id? string -

'type? string -

pagerduty: InlineResponse20050SupportingService

The reference to the service that supports the Business Service.

Fields

id? string -

'type? string -

pagerduty: InlineResponse20051

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

services Service[] -

pagerduty: InlineResponse20052

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

rules? ServiceEventRule[] - The paginated list of Event Rules of the Service.

pagerduty: InlineResponse20053

Fields

Fields Included from *CursorPagination

limit int
next_cursor string|()
anydata...

status_dashboards? StatusDashboard[] -

pagerduty: InlineResponse20054

Fields

status_dashboard? StatusDashboard -

pagerduty: InlineResponse20055

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

users? EntityReference[] -

teams? EntityReference[] -

escalation_policies? EntityReference[] -

pagerduty: InlineResponse20056

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

teams Team[] -

pagerduty: InlineResponse20057

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

members? InlineResponse20057Members[] -

pagerduty: InlineResponse20057Members

Fields

user? UserReference -

role? string -

pagerduty: InlineResponse20058

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

subscriptions InlineResponse20058Subscriptions[] -

pagerduty: InlineResponse20058Subscriptions

Fields

subscription? NotificationSubscription - An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable.

subscribable_name? string? - The name of the subscribable

pagerduty: InlineResponse20059

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

users User[] -

pagerduty: InlineResponse2006

Fields

business_service BusinessService -

pagerduty: InlineResponse20060

Fields

contact_methods? (PhoneContactMethod|PushContactMethod|EmailContactMethod)[] -

pagerduty: InlineResponse20061

Fields

notification_rules NotificationRule[] -

pagerduty: InlineResponse20062

Fields

notification_rule? NotificationRule -

pagerduty: InlineResponse20063

Fields

user_sessions UserSession[] -

pagerduty: InlineResponse20064

Fields

user_session UserSession -

pagerduty: InlineResponse20065

Fields

status_update_notification_rules StatusUpdateNotificationRule[] -

pagerduty: InlineResponse20066

Fields

notification_rule StatusUpdateNotificationRule - A rule for contacting the user for Incident Status Updates.

pagerduty: InlineResponse20067

Fields

notification_rule? StatusUpdateNotificationRule - A rule for contacting the user for Incident Status Updates.

pagerduty: InlineResponse20068

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

vendors Vendor[] -

pagerduty: InlineResponse20069

Fields

vendor Vendor[] -

pagerduty: InlineResponse2007

Fields

account_is_subscribed boolean -

pagerduty: InlineResponse20070

Fields

webhook_subscriptions WebhookSubscription[] -

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

pagerduty: InlineResponse2008

Fields

Fields Included from *Pagination

offset int
limit int
more boolean
total int|()
anydata...

subscribers? NotificationSubscriber[] -

account_id? string - The ID of the account belonging to the subscriber entity

pagerduty: InlineResponse2009

Fields

subscriptions? NotificationSubscriptionWithContext[] -

pagerduty: InlineResponse201

Fields

addon AddonReference -

pagerduty: InlineResponse2011

Fields

incident Incident -

pagerduty: InlineResponse2012

Fields

response_play? ResponsePlay -

pagerduty: InlineResponse2013

Fields

ruleset? Ruleset -

pagerduty: InlineResponse2014

Fields

rule? EventRule -

pagerduty: InlineResponse2015

Fields

overrides Override[] -

pagerduty: InlineResponse2016

Fields

status? decimal - HTTP Status Code reflecting the result of creating this specific override, e.g. 201 for success, 400 for invalid parameters.

errors? string[] - If present, an array of strings representing human-readable explanations for errors found.

override Override -

pagerduty: InlineResponse2017

Fields

rule? ServiceEventRule -

pagerduty: InlineResponse2018

Fields

contact_method? PhoneContactMethod|PushContactMethod|EmailContactMethod -

pagerduty: InlineResponse2019

Fields

status_update_notification_rule StatusUpdateNotificationRule - A rule for contacting the user for Incident Status Updates.

pagerduty: InlineResponse409

Fields

'error? InlineResponse409Error -

pagerduty: InlineResponse409Error

Fields

code? int -

message? string - Error message string

errors? string[] -

pagerduty: Integration

Fields

'type? string -

name? string - The name of this integration.

'service? ServiceReference -

created_at? string - The date/time when this integration was created.

vendor? VendorReference -

integration_email? string - Specify for generic_email_inbound_integration. Must be set to an email address @your-subdomain.pagerduty.com

email_incident_creation? string - Specify for generic_email_inbound_integration

email_filter_mode? string - Specify for generic_email_inbound_integration. May override email_incident_creation

email_parsers? EmailParser[] - Specify for generic_email_inbound_integration.

email_parsing_fallback? string - Specify for generic_email_inbound_integration.

email_filters? IntegrationEmailFilters[] - Specify for generic_email_inbound_integration.

pagerduty: IntegrationEmailFilters

Fields

subject_mode string -

subject_regex? string - Specify if subject_mode is set to match or no-match

body_mode string -

body_regex? string - Specify if body_mode is set to match or no-match

from_email_mode string -

from_email_regex? string - Specify if from_email_mode is set to match or no-match

pagerduty: IntegrationReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: IntegrationsIntegrationIdBody

Fields

integration Integration -

pagerduty: LiveListResponse

Fields

'limit? int - Echoes limit pagination property.

more? boolean - Indicates if there are additional records to return

pagerduty: LogEntriesidchannelChannel

The parameters to update.

Fields

details string - New channel details

'type string - Channel type. Cannot be changed and must match the present value.

pagerduty: LogEntry

Fields

'type? string -

created_at? string - Time at which the log entry was created.

channel? Channel - Polymorphic object representation of the means by which the action was channeled. Has different formats depending on type, indicated by channel[type]. Will be one of auto, email, api, nagios, or timeout if agent[type] is service. Will be one of email, sms, website, web_trigger, or note if agent[type] is user. See below for detailed information about channel formats.

agent? AgentReference -

note? string - Optional field containing a note, if one was included with the log entry.

contexts? Context[] - Contexts to be included with the trigger such as links to graphs or images.

'service? ServiceReference -

incident? IncidentReference -

teams? TeamReference[] - Will consist of references unless included

event_details? LogentryEventDetails -

pagerduty: LogentryEventDetails

Fields

description? string - Additional details about the event.

pagerduty: LogEntryReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: MaintenanceWindow

Fields

'type string - The type of object being created.

sequence_number? int - The order in which the maintenance window was created.

start_time string - This maintenance window's start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.

end_time string - This maintenance window's end time. This is when the services will start creating incidents again. This date must be in the future and after the start_time.

description? string - A description for this maintenance window.

created_by? UserReference -

services ServiceReference[] -

teams? TeamReference[] -

pagerduty: MaintenanceWindowReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: MaintenanceWindowsBody

Fields

maintenance_window MaintenanceWindow -

pagerduty: MaintenanceWindowsIdBody

Fields

maintenance_window MaintenanceWindow -

pagerduty: MatchPredicate

Fields

'type string -

matcher? string - Required if the type is contains, exactly or regex.

part string - The email field that will attempt to use the matcher expression. Required if the type is contains, exactly or regex.

children MatchPredicate[] - Additional matchers to be run. Must be not empty if the type is all, any, or not.

pagerduty: Notification

Fields

id? string -

'type? string - The type of notification.

started_at? string - The time at which the notification was sent

address? string - The address where the notification was sent. This will be null for notification type push_notification.

user? UserReference -

pagerduty: NotificationRule

Fields

'type string - The type of object being created.

start_delay_in_minutes int - The delay before firing the rule, in minutes.

contact_method ContactMethodReference -

urgency string - Which incident urgency this rule is used for. Account must have the urgencies ability to have a low urgency notification rule.

pagerduty: NotificationRuleReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: NotificationRulesNotificationRuleIdBody

Fields

notification_rule NotificationRule -

pagerduty: NotificationSubscribable

A reference of a subscribable entity.

Fields

subscribable_id? string - The ID of the entity to subscribe to

subscribable_type? string - The type of the entity being subscribed to

pagerduty: NotificationSubscriber

A reference of a subscriber entity.

Fields

subscriber_id? string - The ID of the entity being subscribed

subscriber_type? string - The type of the entity being subscribed

pagerduty: NotificationSubscriberWithContext

A reference of a subscriber entity with additional subscription context.

Fields

subscriber_id? string - The ID of the entity being subscribed

subscriber_type? string - The type of the entity being subscribed

has_indirect_subscription? boolean - If this subcriber has an indirect subscription to this incident via another object

subscribed_via? NotificationsubscriberwithcontextSubscribedVia[]? -

pagerduty: NotificationsubscriberwithcontextSubscribedVia

Fields

id? string - The id of the object this subscriber is subscribed via

name? string - The type of the object this subscriber is subscribed via

pagerduty: NotificationSubscription

An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable.

Fields

subscriber_id? string - The ID of the entity being subscribed

subscriber_type? string - The type of the entity being subscribed

subscribable_id? string - The ID of the entity being subscribed to

subscribable_type? string - The type of the entity being subscribed to

account_id? string - The ID of the account belonging to the subscriber entity

pagerduty: NotificationSubscriptionsUnsubscribeBody

Fields

subscribables NotificationSubscribable[] -

pagerduty: NotificationSubscriptionsUnsubscribeBody1

Fields

subscribables NotificationSubscribable[] -

pagerduty: NotificationSubscriptionWithContext

An object describing the relationship of a NotificationSubscriber and a NotificationSubscribable with additional context on status of subscription attempt.

Fields

subscriber_id? string - The ID of the entity being subscribed

subscriber_type? string - The type of the entity being subscribed

subscribable_id? string - The ID of the entity being subscribed to

subscribable_type? string - The type of the entity being subscribed to

account_id? string - The type of the entity being subscribed to

result? string - The resulting status of the subscription

pagerduty: NotifyLogEntry

Fields

Fields Included from *LogEntry

type string
created_at string
channel Channel
agent AgentReference
note string
contexts Context[]
service ServiceReference
incident IncidentReference
teams TeamReference[]
event_details LogentryEventDetails
anydata...

created_at? string - Time at which the log entry was created

user? UserReference -

'type? string -

pagerduty: Oncall

Fields

escalation_policy? EscalationPolicyReference -

user? UserReference -

schedule? ScheduleReference -

escalation_level? int - The escalation level for the on-call.

'start? string - The start of the on-call. If null, the on-call is a permanent user on-call.

end? string - The end of the on-call. If null, the user does not go off-call.

pagerduty: OutboundIntegrationReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: Override

Fields

id? string -

'start string - The start date and time for the override.

end string - The end date and time for the override.

user UserReference -

Fields

offset? int - Echoes offset pagination property.

'limit? int - Echoes limit pagination property.

more? boolean - Indicates if there are additional records to return

total? int? - The total number of records matching the given query.

pagerduty: PhoneContactMethod

The Phone Contact Method of the User, used for Voice or SMS.

Fields

Fields Included from *ContactMethod

type string
label string
address string
anydata...

'type? string -

country_code int - The 1-to-3 digit country calling code.

enabled? boolean - If true, this phone is capable of receiving SMS messages.

blacklisted? boolean - If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.

pagerduty: Priority

Fields

name? string - The user-provided short name of the priority.

description? string - The user-provided description of the priority.

pagerduty: PriorityReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

pagerduty: PushContactMethod

The Push Contact Method of the User.

Fields

Fields Included from *ContactMethod

type string
label string
address string
anydata...

'type? string -

device_type string - The type of device.

sounds? PushContactMethodSound[] -

created_at? string - Time at which the contact method was created.

blacklisted? boolean - If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.

pagerduty: PushContactMethodSound

Fields

'type? string - The type of sound.

file? string - The sound file name.

pagerduty: RawIncidentsBody

Fields

filters? AnalyticsrawincidentsFilters - Filters the result, only show incidents that match the conditions passed in the filter.

starting_after? string - A cursor to indicate the reference point that the results should follow

ending_before? string - A cursor to indicate the reference point that the results should precede

'order? string - The order the results; asc for ascending, desc for descending. Defaults to 'desc'.

order_by? string - The column to use for ordering the results. Defaults to 'created_at'.

'limit? int - Number of results to include in each batch. Limits between 1 to 1000 are accepted.

time_zone? string - The time zone to use for the results.

pagerduty: Reference

pagerduty: RelatedIncidentMachineLearningRelationship

The data for a type of relationship where the Incident is related due to our machine learning algorithm.

Fields

grouping_classification? string - The classification for why this Related Incident was grouped into this group. Values can be one of: [similar_contents, prior_feedback], where: similar_contents - The Related Incident was due to similar contents of the Incidents. prior_feedback - The Related Incident was determined to be related, based on User feedback or Incident merge/unmerge actions.

user_feedback? RelatedincidentmachinelearningrelationshipUserFeedback - The feedback provided from Users to influence the machine learning algorithm for future Related Incidents.

pagerduty: RelatedincidentmachinelearningrelationshipUserFeedback

The feedback provided from Users to influence the machine learning algorithm for future Related Incidents.

Fields

positive_feedback_count? int - The total number of times Users agreed that the Incidents are related.

negative_feedback_count? int - The total number of times Users disagreed that the Incidents are related.

pagerduty: RelatedIncidentServiceDependencyBase

Fields

id? string - The ID of the Service referenced.

'type? string - The type of the related Service.

self? string? - The API show URL at which the object is accessible.

pagerduty: RelatedIncidentServiceDependencyRelationship

The data for a type of relationship where the Incident is related due to Business or Technical Service dependencies.

Both dependent_services and supporting_services are returned to signify the dependencies between the Services that the Incident and Related Incident belong to.

Each Service reference returned in the list of supporting and dependent Services has a type of: [business_service_reference, technical_service_reference].

Fields

dependent_services? RelatedIncidentServiceDependencyBase[] -

supporting_services? RelatedIncidentServiceDependencyBase[] -

pagerduty: ResolveReason

Fields

'type? string - The reason the incident was resolved. The only reason currently supported is merge.

incident? IncidentReference -

pagerduty: ResponderRequest

Fields

incident? IncidentReference -

requester? UserReference -

requested_at? string - The time the request was made

message? string - The message sent with the responder request

responder_request_targets? ResponderRequestTargetReference[] - The array of targets the responder request is being sent to

pagerduty: ResponderRequestTargetReference

Fields

'type? string - The type of target (either a user or an escalation policy)

id? string - The id of the user or escalation policy

summary? string -

incident_responders? IncidentsRespondersReference[] - An array of responders associated with the specified incident

pagerduty: ResponsePlay

Fields

'type? string - The type of object being created.

name? string - The name of the response play.

description? string? - The description of the response play.

team? TeamReference|record {} -

subscribers? (UserReference|TeamReference)[]? - An array containing the users and/or teams to be added as subscribers to any incident on which this response play is run.

subscribers_message? string? - The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.

responders? (UserReference|EscalationPolicyReference)[] - An array containing the users and/or escalation policies to be requested as responders to any incident on which this response play is run.

responders_message? string? - The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.

runnability? string - String representing how this response play is allowed to be run. Valid options are:
- services: This response play cannot be manually run by any users. It will run automatically for new incidents triggered on any services that are configured with this response play.
- teams: This response play can be run manually on an incident only by members of its configured team. This option can only be selected when the team property for this response play is not empty.
- responders: This response play can be run manually on an incident by any responders in this account.

conference_number? string? - The telephone number that will be set as the conference number for any incident on which this response play is run.

conference_url? string? - The URL that will be set as the conference URL for any incident on which this response play is run.

conference_type? string - This field has three possible values and indicates how the response play was created.
- none : The response play had no conference_number or conference_url set at time of creation.
- manual : The response play had one or both of conference_number and conference_url set at time of creation.
- zoom : Customers with the Zoom-Integration Entitelment can use this value to dynamicly configure conference number and url for zoom

pagerduty: ResponsePlayIdRunBody

Fields

incident IncidentReference -

pagerduty: ResponsePlaysBody

Fields

response_play ResponsePlay -

pagerduty: ResponsePlaysIdBody

Fields

response_play ResponsePlay -

pagerduty: Restriction

Fields

'type string - Specify the types of restriction.

duration_seconds int - The duration of the restriction in seconds.

start_time_of_day string - The start time in HH:mm:ss format.

start_day_of_week? int - Only required for use with a weekly_restriction restriction type. The first day of the weekly rotation schedule as ISO 8601 day (1 is Monday, etc.)

pagerduty: Ruleset

Fields

id? string - ID of the Ruleset.

self? string - the API show URL at which the object is accessible

'type? string -

name? string - Name of the Ruleset.

routing_keys? string[] - Routing keys routed to this Ruleset.

created_at? string - The date the Ruleset was created at.

creator? RulesetCreator - Reference to the user that has created the Ruleset.

updated_at? string - The date the Ruleset was last updated.

updater? RulesetUpdater - Reference to the user that has updated the Ruleset last.

team? RulesetTeam - Reference to the team that owns the Ruleset. If none is specified, only admins have access.

pagerduty: RulesetCreator

Reference to the user that has created the Ruleset.

Fields

id? string -

'type? string - A string that determines the schema of the object

self? string - The API show URL at which the object is accessible

pagerduty: RulesetsBody

Fields

ruleset record {} -

pagerduty: RulesetsIdBody

Fields

ruleset Ruleset -

pagerduty: RulesetTeam

Reference to the team that owns the Ruleset. If none is specified, only admins have access.

Fields

id string -

'type string - A string that determines the schema of the object

self? string - The API show URL at which the object is accessible

pagerduty: RulesetUpdater

Reference to the user that has updated the Ruleset last.

Fields

id? string -

'type? string - A string that determines the schema of the object

self? string - The API show URL at which the object is accessible

pagerduty: RulesRuleIdBody

Fields

rule? EventRule -

rule_id string - The id of the Event Rule to update.

pagerduty: RulesRuleIdBody1

Fields

rule? ServiceEventRule -

rule_id string - The id of the Event Rule to update on the Service.

pagerduty: Schedule

Fields

'type string - The type of object being created.

schedule_layers? ScheduleLayer[] - A list of schedule layers.

time_zone string - The time zone of the schedule.

name? string - The name of the schedule

description? string - The description of the schedule

final_schedule? SubSchedule -

overrides_subschedule? SubSchedule -

escalation_policies? EscalationPolicyReference[] - An array of all of the escalation policies that uses this schedule.

users? UserReference[] - An array of all of the users on the schedule.

teams? TeamReference[] - An array of all of the teams on the schedule.

pagerduty: ScheduledAction

Fields

'type string - The type of schedule action. Must be set to urgency_change.

at ScheduledactionAt - Represents when scheduled action will occur.

to_urgency string - Urgency level. Must be set to high.

pagerduty: ScheduledactionAt

Represents when scheduled action will occur.

Fields

'type string - Must be set to named_time.

name string - Designates either the start or the end of support hours.

pagerduty: ScheduleLayer

Fields

id? string -

'start string - The start time of this layer.

end? string - The end time of this layer. If null, the layer does not end.

users ScheduleLayerUser[] - The ordered list of users on this layer. The position of the user on the list determines their order in the layer.

restrictions? Restriction[] - An array of restrictions for the layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments.

rotation_virtual_start string - The effective start time of the layer. This can be before the start time of the schedule.

rotation_turn_length_seconds int - The duration of each on-call shift in seconds.

name? string - The name of the schedule layer.

rendered_schedule_entries? ScheduleLayerEntry[] - This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.

rendered_coverage_percentage? decimal - The percentage of the time range covered by this layer. Returns null unless since or until are set.

pagerduty: ScheduleLayerEntry

Fields

user? UserReference -

'start string - The start time of this entry.

end string - The end time of this entry. If null, the entry does not end.

pagerduty: ScheduleLayerUser

Fields

user UserReference -

pagerduty: ScheduleReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: SchedulesBody

Fields

schedule Schedule -

pagerduty: SchedulesIdBody

Fields

schedule Schedule -

pagerduty: SchedulesPreviewBody

Fields

schedule Schedule -

pagerduty: Service

Fields

'type string - The type of object being created.

name? string - The name of the service.

description? string - The user-provided description of the service.

auto_resolve_timeout int(default 14400) - 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.

acknowledgement_timeout int(default 1800) - 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.

created_at? string - The date/time when this service was created

status string(default "active") - 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.

last_incident_timestamp? string - The date/time when the most recent incident was created for this service.

escalation_policy EscalationPolicyReference -

teams? TeamReference[] - The set of teams associated with this service.

integrations? IntegrationReference[] - 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.

incident_urgency_rule? IncidentUrgencyRule -

support_hours? SupportHours -

scheduled_actions? ScheduledAction[] - An array containing scheduled actions for the service.

addons? AddonReference[] - 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_parameters? AlertGroupingParameters - Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans.

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_timeout? int - 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.

pagerduty: ServiceDependenciesAssociateBody

Fields

relationships? ServiceDependenciesassociateRelationships[] - List of all service dependencies to be created.

pagerduty: ServiceDependenciesassociateDependentService

The reference to the service that is dependent on the supporting service.

Fields

id? string -

'type? string -

pagerduty: ServiceDependenciesassociateRelationships

Fields

supporting_service? ServiceDependenciesassociateSupportingService - The reference to the service that supports the dependent service.

dependent_service? ServiceDependenciesassociateDependentService - The reference to the service that is dependent on the supporting service.

pagerduty: ServiceDependenciesassociateSupportingService

The reference to the service that supports the dependent service.

Fields

id? string -

'type? string -

pagerduty: ServiceDependenciesDisassociateBody

Fields

relationships? ServiceDependenciesassociateRelationships[] - List of all service dependencies to be deleted.

pagerduty: ServiceEventRule

Fields

position? int - Position/index of the Event Rule on the Service. Starting from position 0 (the first rule), rules are evaluated one-by-one until a matching Event Rule is found or the end of the list is reached.

actions? EventRuleActionsCommon - When an event matches this Event Rule, the actions that will be taken to change the resulting Alert and Incident.

pagerduty: ServiceReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: ServicesBody

Fields

'service Service -

pagerduty: ServicesIdBody

Fields

'service Service -

pagerduty: SnoozeLogEntry

Fields

Fields Included from *LogEntry

type string
created_at string
channel Channel
agent AgentReference
note string
contexts Context[]
service ServiceReference
incident IncidentReference
teams TeamReference[]
event_details LogentryEventDetails
anydata...

changed_actions? IncidentAction[] -

'type? string -

pagerduty: StatusDashboard

Fields

id? string -

url_slug? string -

name? string -

pagerduty: StatusUpdate

Fields

id? string -

message? string - The message of the status update.

created_at? string - The date/time when this status update was created.

sender? UserReference -

pagerduty: StatusUpdateNotificationRule

A rule for contacting the user for Incident Status Updates.

Fields

contact_method ContactMethodReference -

pagerduty: StatusUpdateNotificationRulesStatusUpdateNotificationRuleIdBody

Fields

status_update_notification_rule StatusUpdateNotificationRule - A rule for contacting the user for Incident Status Updates.

pagerduty: StatusUpdatesSubscribersBody

Fields

subscribers NotificationSubscriber[] -

pagerduty: StatusUpdatesUnsubscribeBody

Fields

subscribers NotificationSubscriber[] -

pagerduty: SubSchedule

Fields

name string - The name of the subschedule

rendered_schedule_entries? ScheduleLayerEntry[] - This is a list of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated.

rendered_coverage_percentage? decimal - The percentage of the time range covered by this layer. Returns null unless since or until are set.

pagerduty: SupportHours

Fields

'type? string - The type of support hours

time_zone? string - The time zone for the support hours

days_of_week? int[] -

start_time? string - The support hours' starting time of day (date portion is ignored)

end_time? string - The support hours' ending time of day (date portion is ignored)

pagerduty: Tag

Fields

id? string -

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.

'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.

self? string? - the API show URL at which the object is accessible

html_url? string? - a URL at which the entity is uniquely displayed in the Web app

created_type string(default "tag") - The type of object being created.

label string - The label of the tag.

pagerduty: TagReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: TagsBody

Fields

tag Tag -

pagerduty: TagsToAdd

Fields

'type string -

label? string - The label of the tag. Should be used when type is "tag".

id? string - The id of the tag. Should be used when type is "tag_reference".

pagerduty: Team

Fields

'type string - The type of object being created.

name string - The name of the team.

description? string - The description of the team.

parent? TeamReference -

pagerduty: Team1

Reference to the team that owns the Business Service.

Fields

id? string - The Team ID

pagerduty: Team2

Reference to the team that owns the Business Service.

Fields

id? string - The team ID

pagerduty: Team3

Reference to the team that owns the business service.

Fields

id string -

'type? string - A string that determines the schema of the object.

self? string - The API show URL at which the object is accessible.

pagerduty: TeamReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: TeamsBody

Fields

team Team -

pagerduty: TeamsIdBody

Fields

team Team -

pagerduty: TimeBasedAlertGroupingConfiguration

The configuration for Time Based Alert Grouping

Fields

timeout? int - The duration in minutes within which to automatically group incoming Alerts. To continue grouping Alerts until the Incident is resolved, set this value to 0.

pagerduty: User

Fields

name string - The name of the user.

'type string - The type of object being created.

email string - The user's email address.

time_zone? string - The preferred time zone name. If null, the account's time zone will be used.

color? string - The schedule color.

role? string - The user role. Account must have the read_only_users ability to set a user as a read_only_user or a read_only_limited_user, and must have advanced permissions abilities to set a user as observer or restricted_access.

avatar_url? string - The URL of the user's avatar.

description? string? - The user's bio.

invitation_sent? boolean - If true, the user has an outstanding invitation.

job_title? string - The user's title.

teams? TeamReference[] - The list of teams to which the user belongs. Account must have the teams ability to set this.

contact_methods? ContactMethodReference[] - The list of contact methods for the user.

notification_rules? NotificationRuleReference[] - The list of notification rules for the user.

pagerduty: UserReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: UserRole

Fields

role? string - The role of the user for a set of resources.

resources? Reference[] -

pagerduty: UsersBody

Fields

user User -

pagerduty: UserSession

Fields

id string -

user_id string -

created_at string - The date/time the user session was first created.

'type string - The type of the session

summary string - The summary of the session

pagerduty: UsersIdBody

Fields

user User -

pagerduty: UsersUserIdBody

Fields

role? string - The role of the user on the team.

pagerduty: Vendor

Fields

name? string - The short name of the vendor

website_url? string - URL of the vendor's main website

logo_url? string - URL of a logo identifying the vendor

thumbnail_url? string - URL of a small thumbnail image identifying the vendor

description? string - A short description of this vendor, and common use-cases of integrations for this vendor.

integration_guide_url? string - URL of an integration guide for this vendor

pagerduty: VendorReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: Webhook

Information about the configured webhook.

Fields

endpoint_url? string - The url endpoint the webhook payload is sent to.

name? string - The name of the webhook.

webhook_object? WebhookObject -

config? record {} - The object that contains webhook configuration values depending on the webhook type specification.

outbound_integration? OutboundIntegrationReference -

pagerduty: WebhookIncidentAction

Fields

Fields Included from *Action

id string
triggered_at string
webhook Webhook
anydata...

'type? string - The type of action being reported by this message. * incident.trigger - Sent when an incident is newly created/triggered. * incident.acknowledge - Sent when an incident is acknowledged by a user. * incident.unacknowledge - Sent when an incident is unacknowledged due to its acknowledgement timing out. * incident.resolve - Sent when an incident has been resolved. * incident.assign - Sent when an incident has been assigned to another user. Often occurs in concert with an acknowledge. * incident.escalate - Sent when an incident has been escalated to another user in the same escalation chain. * incident.delegate - Sent when an incident has been reassigned to another escalation policy. * incident.annotate - Sent when a note is created on an incident.

incident? Incident -

log_entries? LogEntry[] - Log Entries that correspond to the action this Webhook is reporting. Includes the channels.

pagerduty: WebhookObject

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: WebhookReference

Fields

Fields Included from *Reference

anydata...

'type? string -

pagerduty: WebhookSubscription

Fields

id? string -

'type string - The type indicating the schema of the object.

active boolean(default true) - Determines whether this subscription will produce webhook events.

delivery_method WebhooksubscriptionDeliveryMethod -

description? string - A short description of the webhook subscription.

events string[] - The set of outbound event types the webhook will receive.

filter WebhooksubscriptionFilter -

pagerduty: WebhooksubscriptionDeliveryMethod

Fields

id? string -

secret? string? - The secret used to sign webhook payloads. Only provided on the initial create response.

temporarily_disabled? boolean - Whether or not this webhook subscription is temporarily disabled. Becomes true if the delivery method URL is repeatedly rejected by the server.

'type string - Indicates the type of the delivery method.

url string - The destination URL for webhook delivery.

pagerduty: WebhooksubscriptionFilter

Fields

id? string - The id of the object being used as the filter. This field is required for all filter types except account_reference.

'type string - The type of object being used as the filter.

pagerduty: WebhookSubscriptionsBody

Fields

webhook_subscription WebhookSubscription -

pagerduty: WebhookSubscriptionUpdate

Fields

webhook_subscription? WebhooksubscriptionupdateWebhookSubscription -

pagerduty: WebhooksubscriptionupdateWebhookSubscription

Fields

description? string - A short description of the webhook subscription.

events? string[] - The set of outbound event types the subscription will receive.

filter? WebhooksubscriptionupdateWebhookSubscriptionFilter -

active? boolean - If true, a webhook will be sent. True is the default state. If false, a webhook will not be sent.

pagerduty: WebhooksubscriptionupdateWebhookSubscriptionFilter

Fields

id? string - The id of the object being used as the filter. This field is required for all filter types except account_reference.

'type? string - The type of object being used as the filter.

pagerduty: WebhooksV1AssignedTo

Fields

at? string - Time at which the assignment was created.

'object? record { 'type string } -

pagerduty: WebhooksV1AssignedToUser

The user assigned to the incident.

Fields

id? string -

name? string - The user's name.

email? string - The user's email address.

html_url? string -

pagerduty: WebhooksV1IncidentData

The incident details at the time of the state change.

Fields

id? string -

incident_number? int - The number of the incident. This is unique across the account.

created_on? string - The date/time the incident was first triggered.

status? string - The current status of the incident.

html_url? string -

incident_key? string - The incident's de-duplication key.

'service? WebhooksV1Service - The service on which the incident occurred.

assigned_to_user? WebhooksV1AssignedToUser - The user assigned to the incident.

assigned_to? WebhooksV1AssignedTo[] -

trigger_summary_data? Webhooksv1incidentdataTriggerSummaryData -

trigger_details_html_url? string -

last_status_change_on? string - The time at which the status of the incident last changed.

last_status_change_by? WebhooksV1AssignedToUser - The user assigned to the incident.

number_of_escalations? int - Number of times the incident has been escalated.

urgency? string -

pagerduty: Webhooksv1incidentdataTriggerSummaryData

Fields

subject? string -

pagerduty: WebhooksV1Message

A message containing information about a single PagerDuty action.

Fields

id? string - Uniquely identifies this outgoing webhook message; can be used for idempotency when processing the messages.

'type? string - The type of action being reported by this message.

created_on? string - The date/time when the incident changed state.

data? Webhooksv1messageData -

pagerduty: Webhooksv1messageData

Fields

incident? WebhooksV1IncidentData - The incident details at the time of the state change.

pagerduty: WebhooksV1Service

The service on which the incident occurred.

Fields

id? string -

name? string - The name of the service.

html_url? string -

deleted_at? string - The date/time the service was deleted, if it has been removed.

description? string - The description of the service.

pagerduty: WeeklyRestriction

Fields

Fields Included from *Restriction

type string
duration_seconds int
start_time_of_day string
start_day_of_week int
anydata...

start_day_of_week int - The first day of the weekly rotation schedule as ISO 8601 day (1 is Monday, etc.)

Array types

pagerduty: InlineResponse2016Arr

InlineResponse2016[]

InlineResponse2016Arr

Import

import ballerinax/pagerduty;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: 9 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 28

Current verison: 5

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/PagerDuty

Area/CRM & Sales

Support/Customer Support

Cost/Freemium

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/constraint/1.5.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

arrayTypes

ballerinax/pagerduty Ballerina library

Overview

Key Features

Prerequisites

Clients

pagerduty: Client

Constructor

createEntityTypeByIdChangeTags

Parameters

Return Type

getEntityTypeByIdTags

Parameters

Return Type

listAbilities

Parameters

Return Type

getAbility

Parameters

Return Type

listAddon

Parameters

Return Type

createAddon

Parameters

Return Type

getAddon

Parameters

Return Type

updateAddon

Parameters

Return Type

deleteAddon

Parameters

Return Type

getAnalyticsMetricsIncidentsAll

Parameters

Return Type

getAnalyticsMetricsIncidentsService

Parameters

Return Type

getAnalyticsMetricsIncidentsTeam

Parameters

Return Type

getAnalyticsIncidents

Parameters

Return Type

getAnalyticsIncidentsById

Parameters

listAuditRecords

Parameters

Return Type

listBusinessServices

Parameters

Return Type

createBusinessService

Parameters

Return Type

getBusinessService

Parameters

Return Type

updateBusinessService

Parameters

Return Type

deleteBusinessService

Parameters

Return Type

createBusinessServiceAccountSubscription

Parameters

Return Type

removeBusinessServiceAccountSubscription

Parameters

Return Type

getBusinessServiceSubscribers

Parameters

Return Type

createBusinessServiceNotificationSubscribers

Parameters