Skip to content

Commit e37b988

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
add On-Call Paging spec (#2216)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 1acae3f commit e37b988

22 files changed

+1612
-4
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-05-09 19:42:42.683518",
8-
"spec_repo_commit": "c7bad6f6"
7+
"regenerated": "2025-05-12 09:40:18.957439",
8+
"spec_repo_commit": "c4d0aeef"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-09 19:42:42.700662",
13-
"spec_repo_commit": "c7bad6f6"
12+
"regenerated": "2025-05-12 09:40:19.013366",
13+
"spec_repo_commit": "c4d0aeef"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 341 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9471,6 +9471,108 @@ components:
94719471
id:
94729472
$ref: '#/components/schemas/ApiID'
94739473
type: object
9474+
CreatePageRequest:
9475+
description: Full request to trigger an On-Call Page.
9476+
example:
9477+
data:
9478+
attributes:
9479+
description: Page details.
9480+
tags:
9481+
- service:test
9482+
target:
9483+
identifier: my-team
9484+
type: team_handle
9485+
title: Page title
9486+
urgency: low
9487+
type: pages
9488+
properties:
9489+
data:
9490+
$ref: '#/components/schemas/CreatePageRequestData'
9491+
type: object
9492+
CreatePageRequestData:
9493+
description: The main request body, including attributes and resource type.
9494+
properties:
9495+
attributes:
9496+
$ref: '#/components/schemas/CreatePageRequestDataAttributes'
9497+
type:
9498+
$ref: '#/components/schemas/CreatePageRequestDataType'
9499+
required:
9500+
- type
9501+
type: object
9502+
CreatePageRequestDataAttributes:
9503+
description: Details about the On-Call Page you want to create.
9504+
properties:
9505+
description:
9506+
description: A short summary of the issue or context.
9507+
type: string
9508+
tags:
9509+
description: Tags to help categorize or filter the page.
9510+
items:
9511+
type: string
9512+
type: array
9513+
target:
9514+
$ref: '#/components/schemas/CreatePageRequestDataAttributesTarget'
9515+
title:
9516+
description: The title of the page.
9517+
example: 'Service: Test is down'
9518+
type: string
9519+
urgency:
9520+
$ref: '#/components/schemas/PageUrgency'
9521+
required:
9522+
- target
9523+
- title
9524+
- urgency
9525+
type: object
9526+
CreatePageRequestDataAttributesTarget:
9527+
description: Information about the target to notify (such as a team or user).
9528+
properties:
9529+
identifier:
9530+
description: A unique ID for the target (for example, team handle or user
9531+
UUID).
9532+
type: string
9533+
type:
9534+
description: The kind of target, `team_uuid` | `team_handle` | `user_uuid`.
9535+
type: string
9536+
type: object
9537+
CreatePageRequestDataType:
9538+
default: pages
9539+
description: The type of resource used when creating an On-Call Page.
9540+
enum:
9541+
- pages
9542+
example: pages
9543+
type: string
9544+
x-enum-varnames:
9545+
- PAGES
9546+
CreatePageResponse:
9547+
description: The full response object after creating a new On-Call Page.
9548+
example:
9549+
data:
9550+
id: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
9551+
type: pages
9552+
properties:
9553+
data:
9554+
$ref: '#/components/schemas/CreatePageResponseData'
9555+
type: object
9556+
CreatePageResponseData:
9557+
description: The information returned after successfully creating a page.
9558+
properties:
9559+
id:
9560+
description: The unique ID of the created page.
9561+
type: string
9562+
type:
9563+
$ref: '#/components/schemas/CreatePageResponseDataType'
9564+
required:
9565+
- type
9566+
type: object
9567+
CreatePageResponseDataType:
9568+
default: pages
9569+
description: The type of resource used when creating an On-Call Page.
9570+
enum:
9571+
- pages
9572+
example: pages
9573+
type: string
9574+
x-enum-varnames:
9575+
- PAGES
94749576
CreateRuleRequest:
94759577
description: Scorecard create rule request.
94769578
properties:
@@ -27104,6 +27206,17 @@ components:
2710427206
- ARRAY_NUMBER
2710527207
- ARRAY_BOOLEAN
2710627208
- ARRAY_OBJECT
27209+
PageUrgency:
27210+
default: high
27211+
description: On-Call Page urgency level.
27212+
enum:
27213+
- low
27214+
- high
27215+
example: high
27216+
type: string
27217+
x-enum-varnames:
27218+
- LOW
27219+
- HIGH
2710727220
Pagination:
2710827221
description: Pagination object.
2710927222
properties:
@@ -38863,6 +38976,7 @@ components:
3886338976
- low
3886438977
- high
3886538978
- dynamic
38979+
example: low
3886638980
type: string
3886738981
x-enum-varnames:
3886838982
- LOW
@@ -51416,6 +51530,227 @@ paths:
5141651530
operator: AND
5141751531
permissions:
5141851532
- on_call_write
51533+
/api/v2/on-call/pages:
51534+
post:
51535+
description: 'Trigger a new On-Call Page.
51536+
51537+
'
51538+
operationId: CreateOnCallPage
51539+
requestBody:
51540+
content:
51541+
application/json:
51542+
schema:
51543+
$ref: '#/components/schemas/CreatePageRequest'
51544+
required: true
51545+
responses:
51546+
'200':
51547+
content:
51548+
application/json:
51549+
schema:
51550+
$ref: '#/components/schemas/CreatePageResponse'
51551+
description: OK.
51552+
'429':
51553+
$ref: '#/components/responses/TooManyRequestsResponse'
51554+
security:
51555+
- apiKeyAuth: []
51556+
appKeyAuth: []
51557+
- AuthZ: []
51558+
servers:
51559+
- url: https://{site}
51560+
variables:
51561+
site:
51562+
default: navy.oncall.datadoghq.com
51563+
description: The globally available endpoint for On-Call.
51564+
enum:
51565+
- saffron.oncall.datadoghq.com
51566+
- navy.oncall.datadoghq.com
51567+
- coral.oncall.datadoghq.com
51568+
- teal.oncall.datadoghq.com
51569+
- beige.oncall.datadoghq.eu
51570+
- url: '{protocol}://{name}'
51571+
variables:
51572+
name:
51573+
default: api.datadoghq.com
51574+
description: Full site DNS name.
51575+
protocol:
51576+
default: https
51577+
description: The protocol for accessing the API.
51578+
- url: https://{subdomain}.{site}
51579+
variables:
51580+
site:
51581+
default: datadoghq.com
51582+
description: Any Datadog deployment.
51583+
subdomain:
51584+
default: api
51585+
description: The subdomain where the API is deployed.
51586+
summary: Create On-Call Page
51587+
tags:
51588+
- On-Call Paging
51589+
/api/v2/on-call/pages/{page_id}/acknowledge:
51590+
post:
51591+
description: 'Acknowledges an On-Call Page.
51592+
51593+
'
51594+
operationId: AcknowledgeOnCallPage
51595+
parameters:
51596+
- description: The page ID.
51597+
in: path
51598+
name: page_id
51599+
required: true
51600+
schema:
51601+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51602+
format: uuid
51603+
type: string
51604+
responses:
51605+
'202':
51606+
description: Accepted.
51607+
'429':
51608+
$ref: '#/components/responses/TooManyRequestsResponse'
51609+
security:
51610+
- apiKeyAuth: []
51611+
appKeyAuth: []
51612+
- AuthZ: []
51613+
servers:
51614+
- url: https://{site}
51615+
variables:
51616+
site:
51617+
default: navy.oncall.datadoghq.com
51618+
description: The globally available endpoint for On-Call.
51619+
enum:
51620+
- saffron.oncall.datadoghq.com
51621+
- navy.oncall.datadoghq.com
51622+
- coral.oncall.datadoghq.com
51623+
- teal.oncall.datadoghq.com
51624+
- beige.oncall.datadoghq.eu
51625+
- url: '{protocol}://{name}'
51626+
variables:
51627+
name:
51628+
default: api.datadoghq.com
51629+
description: Full site DNS name.
51630+
protocol:
51631+
default: https
51632+
description: The protocol for accessing the API.
51633+
- url: https://{subdomain}.{site}
51634+
variables:
51635+
site:
51636+
default: datadoghq.com
51637+
description: Any Datadog deployment.
51638+
subdomain:
51639+
default: api
51640+
description: The subdomain where the API is deployed.
51641+
summary: Acknowledge On-Call Page
51642+
tags:
51643+
- On-Call Paging
51644+
/api/v2/on-call/pages/{page_id}/escalate:
51645+
post:
51646+
description: 'Escalates an On-Call Page.
51647+
51648+
'
51649+
operationId: EscalateOnCallPage
51650+
parameters:
51651+
- description: The page ID.
51652+
in: path
51653+
name: page_id
51654+
required: true
51655+
schema:
51656+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51657+
format: uuid
51658+
type: string
51659+
responses:
51660+
'202':
51661+
description: Accepted.
51662+
'429':
51663+
$ref: '#/components/responses/TooManyRequestsResponse'
51664+
security:
51665+
- apiKeyAuth: []
51666+
appKeyAuth: []
51667+
- AuthZ: []
51668+
servers:
51669+
- url: https://{site}
51670+
variables:
51671+
site:
51672+
default: navy.oncall.datadoghq.com
51673+
description: The globally available endpoint for On-Call.
51674+
enum:
51675+
- saffron.oncall.datadoghq.com
51676+
- navy.oncall.datadoghq.com
51677+
- coral.oncall.datadoghq.com
51678+
- teal.oncall.datadoghq.com
51679+
- beige.oncall.datadoghq.eu
51680+
- url: '{protocol}://{name}'
51681+
variables:
51682+
name:
51683+
default: api.datadoghq.com
51684+
description: Full site DNS name.
51685+
protocol:
51686+
default: https
51687+
description: The protocol for accessing the API.
51688+
- url: https://{subdomain}.{site}
51689+
variables:
51690+
site:
51691+
default: datadoghq.com
51692+
description: Any Datadog deployment.
51693+
subdomain:
51694+
default: api
51695+
description: The subdomain where the API is deployed.
51696+
summary: Escalate On-Call Page
51697+
tags:
51698+
- On-Call Paging
51699+
/api/v2/on-call/pages/{page_id}/resolve:
51700+
post:
51701+
description: 'Resolves an On-Call Page.
51702+
51703+
'
51704+
operationId: ResolveOnCallPage
51705+
parameters:
51706+
- description: The page ID.
51707+
in: path
51708+
name: page_id
51709+
required: true
51710+
schema:
51711+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51712+
format: uuid
51713+
type: string
51714+
responses:
51715+
'202':
51716+
description: Accepted.
51717+
'429':
51718+
$ref: '#/components/responses/TooManyRequestsResponse'
51719+
security:
51720+
- apiKeyAuth: []
51721+
appKeyAuth: []
51722+
- AuthZ: []
51723+
servers:
51724+
- url: https://{site}
51725+
variables:
51726+
site:
51727+
default: navy.oncall.datadoghq.com
51728+
description: The globally available endpoint for On-Call.
51729+
enum:
51730+
- saffron.oncall.datadoghq.com
51731+
- navy.oncall.datadoghq.com
51732+
- coral.oncall.datadoghq.com
51733+
- teal.oncall.datadoghq.com
51734+
- beige.oncall.datadoghq.eu
51735+
- url: '{protocol}://{name}'
51736+
variables:
51737+
name:
51738+
default: api.datadoghq.com
51739+
description: Full site DNS name.
51740+
protocol:
51741+
default: https
51742+
description: The protocol for accessing the API.
51743+
- url: https://{subdomain}.{site}
51744+
variables:
51745+
site:
51746+
default: datadoghq.com
51747+
description: Any Datadog deployment.
51748+
subdomain:
51749+
default: api
51750+
description: The subdomain where the API is deployed.
51751+
summary: Resolve On-Call Page
51752+
tags:
51753+
- On-Call Paging
5141951754
/api/v2/on-call/schedules:
5142051755
post:
5142151756
description: Create a new on-call schedule
@@ -61556,6 +61891,12 @@ tags:
6155661891
externalDocs:
6155761892
url: https://docs.datadoghq.com/service_management/on-call/
6155861893
name: On-Call
61894+
- description: 'Trigger and manage [Datadog On-Call](https://docs.datadoghq.com/service_management/on-call/)
61895+
61896+
pages directly through the Datadog API.'
61897+
externalDocs:
61898+
url: https://docs.datadoghq.com/service_management/on-call/
61899+
name: On-Call Paging
6155961900
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
6156061901

6156161902
directly through the Datadog API.'

0 commit comments

Comments
 (0)