Skip to content

add On-Call Paging spec #2551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-09 02:41:27.605914",
"spec_repo_commit": "39adb7c0"
"regenerated": "2025-05-09 15:56:08.863506",
"spec_repo_commit": "20864672"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-05-09 02:41:27.620499",
"spec_repo_commit": "39adb7c0"
"regenerated": "2025-05-09 15:56:08.878760",
"spec_repo_commit": "20864672"
}
}
}
332 changes: 332 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9200,6 +9200,111 @@ components:
id:
$ref: '#/components/schemas/ApiID'
type: object
CreatePageRequest:
description: Full request to trigger an On-Call Page.
example:
data:
attributes:
description: Page details.
tags:
- service:test
target:
identifier: my-team
type: team_handle
title: Page title
urgency: low
type: pages
properties:
data:
$ref: '#/components/schemas/CreatePageRequestData'
type: object
CreatePageRequestData:
description: The main request body, including attributes and resource type.
properties:
attributes:
$ref: '#/components/schemas/CreatePageRequestDataAttributes'
type:
$ref: '#/components/schemas/CreatePageRequestDataType'
required:
- type
type: object
CreatePageRequestDataAttributes:
description: Details about the On-Call Page you want to create.
properties:
description:
description: A short summary of the issue or context.
type: string
tags:
description: Tags to help categorize or filter the page.
items:
type: string
type: array
target:
$ref: '#/components/schemas/CreatePageRequestDataAttributesTarget'
title:
description: The title of the page.
example: 'Service: Test is down'
type: string
urgency:
description: The level of urgency for the alert. Possible value `low` or
`high`.
example: high
type: string
required:
- target
- title
- urgency
type: object
CreatePageRequestDataAttributesTarget:
description: Information about the target to notify (such as a team or user).
properties:
identifier:
description: A unique ID for the target (for example, team handle or user
UUID).
type: string
type:
description: The kind of target, `team_uuid` | `team_handle` | `user_uuid`.
type: string
type: object
CreatePageRequestDataType:
default: pages
description: The type of resource used when creating an On-Call Page.
enum:
- pages
example: pages
type: string
x-enum-varnames:
- PAGES
CreatePageResponse:
description: The full response object after creating a new On-Call Page.
example:
data:
id: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
type: pages
properties:
data:
$ref: '#/components/schemas/CreatePageResponseData'
type: object
CreatePageResponseData:
description: The information returned after successfully creating a page.
properties:
id:
description: The unique ID of the created page.
type: string
type:
$ref: '#/components/schemas/CreatePageResponseDataType'
required:
- type
type: object
CreatePageResponseDataType:
default: pages
description: The type of resource used when creating an On-Call Page.
enum:
- pages
example: pages
type: string
x-enum-varnames:
- PAGES
CreateRuleRequest:
description: Scorecard create rule request.
properties:
Expand Down Expand Up @@ -51299,6 +51404,227 @@ paths:
summary: Update on-call escalation policy
tags:
- On-Call
/api/v2/on-call/pages:
post:
description: 'Trigger a new On-Call Page.

'
operationId: CreateOnCallPage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePageRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePageResponse'
description: OK.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
servers:
- url: https://{site}
variables:
site:
default: navy.oncall.datadoghq.com
description: The globally available endpoint for On-Call.
enum:
- saffron.oncall.datadoghq.com
- navy.oncall.datadoghq.com
- coral.oncall.datadoghq.com
- teal.oncall.datadoghq.com
- beige.oncall.datadoghq.eu
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
summary: Create On-Call Page
tags:
- On-Call Paging
/api/v2/on-call/pages/{page_id}/acknowledge:
post:
description: 'Acknowledges an On-Call Page.

'
operationId: AcknowledgeOnCallPage
parameters:
- description: The page ID.
in: path
name: page_id
required: true
schema:
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
format: uuid
type: string
responses:
'202':
description: Accepted.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
servers:
- url: https://{site}
variables:
site:
default: navy.oncall.datadoghq.com
description: The globally available endpoint for On-Call.
enum:
- saffron.oncall.datadoghq.com
- navy.oncall.datadoghq.com
- coral.oncall.datadoghq.com
- teal.oncall.datadoghq.com
- beige.oncall.datadoghq.eu
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
summary: Acknowledge On-Call Page
tags:
- On-Call Paging
/api/v2/on-call/pages/{page_id}/escalate:
post:
description: 'Escalates an On-Call Page.

'
operationId: EscalateOnCallPage
parameters:
- description: The page ID.
in: path
name: page_id
required: true
schema:
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
format: uuid
type: string
responses:
'202':
description: Accepted.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
servers:
- url: https://{site}
variables:
site:
default: navy.oncall.datadoghq.com
description: The globally available endpoint for On-Call.
enum:
- saffron.oncall.datadoghq.com
- navy.oncall.datadoghq.com
- coral.oncall.datadoghq.com
- teal.oncall.datadoghq.com
- beige.oncall.datadoghq.eu
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
summary: Escalate On-Call Page
tags:
- On-Call Paging
/api/v2/on-call/pages/{page_id}/resolve:
post:
description: 'Resolves an On-Call Page.

'
operationId: ResolveOnCallPage
parameters:
- description: The page ID.
in: path
name: page_id
required: true
schema:
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
format: uuid
type: string
responses:
'202':
description: Accepted.
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
servers:
- url: https://{site}
variables:
site:
default: navy.oncall.datadoghq.com
description: The globally available endpoint for On-Call.
enum:
- saffron.oncall.datadoghq.com
- navy.oncall.datadoghq.com
- coral.oncall.datadoghq.com
- teal.oncall.datadoghq.com
- beige.oncall.datadoghq.eu
- url: '{protocol}://{name}'
variables:
name:
default: api.datadoghq.com
description: Full site DNS name.
protocol:
default: https
description: The protocol for accessing the API.
- url: https://{subdomain}.{site}
variables:
site:
default: datadoghq.com
description: Any Datadog deployment.
subdomain:
default: api
description: The subdomain where the API is deployed.
summary: Resolve On-Call Page
tags:
- On-Call Paging
/api/v2/on-call/schedules:
post:
description: Create a new on-call schedule
Expand Down Expand Up @@ -61285,6 +61611,12 @@ tags:
externalDocs:
url: https://docs.datadoghq.com/service_management/on-call/
name: On-Call
- description: 'Trigger and manage [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/)

pages directly through the Datadog API.'
externalDocs:
url: https://docs.datadoghq.com/service_management/on-call/
name: On-Call Paging
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)

directly through the Datadog API.'
Expand Down
7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,13 @@ datadog\_api\_client.v2.api.on\_call\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.on\_call\_paging\_api module
--------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.on_call_paging_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.opsgenie\_integration\_api module
-------------------------------------------------------------

Expand Down
Loading