Skip to content

Commit b161e78

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit c2b31b4e of spec repo
1 parent 7a42db5 commit b161e78

21 files changed

+1413
-4
lines changed

‎.apigentools-info

+4-4
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-02 04:31:15.271278",
8-
"spec_repo_commit": "272cce39"
7+
"regenerated": "2025-05-05 16:24:24.122051",
8+
"spec_repo_commit": "c2b31b4e"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-02 04:31:15.291066",
13-
"spec_repo_commit": "272cce39"
12+
"regenerated": "2025-05-05 16:24:24.138290",
13+
"spec_repo_commit": "c2b31b4e"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

+235
Original file line numberDiff line numberDiff line change
@@ -9200,6 +9200,109 @@ components:
92009200
id:
92019201
$ref: '#/components/schemas/ApiID'
92029202
type: object
9203+
CreatePageRequest:
9204+
description: Full request to trigger an On-Call page.
9205+
example:
9206+
data:
9207+
attributes:
9208+
description: Page details.
9209+
tags:
9210+
- service:test
9211+
target:
9212+
identifier: my-team
9213+
type: team_handle
9214+
title: Page title
9215+
urgency: low
9216+
type: pages
9217+
properties:
9218+
data:
9219+
$ref: '#/components/schemas/CreatePageRequestData'
9220+
type: object
9221+
CreatePageRequestData:
9222+
description: The main request body, including attributes and resource type.
9223+
properties:
9224+
attributes:
9225+
$ref: '#/components/schemas/CreatePageRequestDataAttributes'
9226+
type:
9227+
$ref: '#/components/schemas/CreatePageRequestDataType'
9228+
required:
9229+
- type
9230+
type: object
9231+
CreatePageRequestDataAttributes:
9232+
description: Details about the On-Call Page you want to create.
9233+
properties:
9234+
description:
9235+
description: A short summary of the issue or context.
9236+
type: string
9237+
tags:
9238+
description: Tags to help categorize or filter the page.
9239+
items:
9240+
type: string
9241+
type: array
9242+
target:
9243+
$ref: '#/components/schemas/CreatePageRequestDataAttributesTarget'
9244+
title:
9245+
description: The title of the page.
9246+
example: 'Service: Test is down'
9247+
type: string
9248+
urgency:
9249+
description: The level of urgency for the alert, possible value `low`, `high`.
9250+
example: high
9251+
type: string
9252+
required:
9253+
- target
9254+
- title
9255+
- urgency
9256+
type: object
9257+
CreatePageRequestDataAttributesTarget:
9258+
description: Information about the target to notify (such as a team or user).
9259+
properties:
9260+
identifier:
9261+
description: A unique ID for the target (ex team handle or user UUID).
9262+
type: string
9263+
type:
9264+
description: The kind of target, `team_uuid` | `team_handle` | `user_uuid`.
9265+
type: string
9266+
type: object
9267+
CreatePageRequestDataType:
9268+
default: pages
9269+
description: The type of resource used when creating an On-Call page.
9270+
enum:
9271+
- pages
9272+
example: pages
9273+
type: string
9274+
x-enum-varnames:
9275+
- PAGES
9276+
CreatePageResponse:
9277+
description: The full response object after creating a new On-Call page.
9278+
example:
9279+
data:
9280+
id: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
9281+
type: pages
9282+
properties:
9283+
data:
9284+
$ref: '#/components/schemas/CreatePageResponseData'
9285+
type: object
9286+
CreatePageResponseData:
9287+
description: The information returned after successfully creating a page.
9288+
properties:
9289+
id:
9290+
description: The unique ID of the created page.
9291+
type: string
9292+
type:
9293+
$ref: '#/components/schemas/CreatePageResponseDataType'
9294+
required:
9295+
- type
9296+
type: object
9297+
CreatePageResponseDataType:
9298+
default: pages
9299+
description: The type of resource used when creating an On-Call page.
9300+
enum:
9301+
- pages
9302+
example: pages
9303+
type: string
9304+
x-enum-varnames:
9305+
- PAGES
92039306
CreateRuleRequest:
92049307
description: Scorecard create rule request.
92059308
properties:
@@ -50952,6 +51055,136 @@ paths:
5095251055
summary: Update on-call escalation policy
5095351056
tags:
5095451057
- On-Call
51058+
/api/v2/on-call/pages:
51059+
post:
51060+
description: Trigger a new On-Call page.
51061+
operationId: CreateOnCallPage
51062+
requestBody:
51063+
content:
51064+
application/json:
51065+
schema:
51066+
$ref: '#/components/schemas/CreatePageRequest'
51067+
required: true
51068+
responses:
51069+
'200':
51070+
content:
51071+
application/json:
51072+
schema:
51073+
$ref: '#/components/schemas/CreatePageResponse'
51074+
description: OK.
51075+
'429':
51076+
$ref: '#/components/responses/TooManyRequestsResponse'
51077+
security:
51078+
- apiKeyAuth: []
51079+
appKeyAuth: []
51080+
- AuthZ: []
51081+
summary: Create on call page
51082+
tags:
51083+
- On-Call Paging
51084+
/api/v2/on-call/pages/{page_id}/acknowledge:
51085+
post:
51086+
description: Acknowledges an On-Call page.
51087+
operationId: AcknowledgeOnCallPage
51088+
parameters:
51089+
- description: The page ID.
51090+
in: path
51091+
name: page_id
51092+
required: true
51093+
schema:
51094+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51095+
format: uuid
51096+
type: string
51097+
responses:
51098+
'202':
51099+
description: Accepted.
51100+
'429':
51101+
$ref: '#/components/responses/TooManyRequestsResponse'
51102+
security:
51103+
- apiKeyAuth: []
51104+
appKeyAuth: []
51105+
- AuthZ: []
51106+
summary: Acknowledge on call page
51107+
tags:
51108+
- On-Call Paging
51109+
/api/v2/on-call/pages/{page_id}/escalate:
51110+
post:
51111+
description: Escalates an On-Call page.
51112+
operationId: EscalateOnCallPage
51113+
parameters:
51114+
- description: The page ID.
51115+
in: path
51116+
name: page_id
51117+
required: true
51118+
schema:
51119+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51120+
format: uuid
51121+
type: string
51122+
responses:
51123+
'202':
51124+
description: Accepted.
51125+
'429':
51126+
$ref: '#/components/responses/TooManyRequestsResponse'
51127+
security:
51128+
- apiKeyAuth: []
51129+
appKeyAuth: []
51130+
- AuthZ: []
51131+
servers:
51132+
- url: https://{site}
51133+
variables:
51134+
site:
51135+
default: navy.oncall.datadoghq.com
51136+
description: The globally available endpoint for On-Call.
51137+
enum:
51138+
- saffron.oncall.datadoghq.com
51139+
- navy.oncall.datadoghq.com
51140+
- coral.oncall.datadoghq.com
51141+
- teal.oncall.datadoghq.com
51142+
- ivory.oncall.datadoghq.eu
51143+
- beige.oncall.datadoghq.eu
51144+
- url: '{protocol}://{name}'
51145+
variables:
51146+
name:
51147+
default: api.datadoghq.com
51148+
description: Full site DNS name.
51149+
protocol:
51150+
default: https
51151+
description: The protocol for accessing the API.
51152+
- url: https://{subdomain}.{site}
51153+
variables:
51154+
site:
51155+
default: datadoghq.com
51156+
description: Any Datadog deployment.
51157+
subdomain:
51158+
default: api
51159+
description: The subdomain where the API is deployed.
51160+
summary: Escalate on call page
51161+
tags:
51162+
- On-Call Paging
51163+
/api/v2/on-call/pages/{page_id}/resolve:
51164+
post:
51165+
description: Resolves an On-Call page.
51166+
operationId: ResolveOnCallPage
51167+
parameters:
51168+
- description: The page ID.
51169+
in: path
51170+
name: page_id
51171+
required: true
51172+
schema:
51173+
example: 15e74b8b-f865-48d0-bcc5-453323ed2c8f
51174+
format: uuid
51175+
type: string
51176+
responses:
51177+
'202':
51178+
description: Accepted.
51179+
'429':
51180+
$ref: '#/components/responses/TooManyRequestsResponse'
51181+
security:
51182+
- apiKeyAuth: []
51183+
appKeyAuth: []
51184+
- AuthZ: []
51185+
summary: Resolve on call page
51186+
tags:
51187+
- On-Call Paging
5095551188
/api/v2/on-call/schedules:
5095651189
post:
5095751190
description: Create a new on-call schedule
@@ -60865,6 +61098,8 @@ tags:
6086561098
externalDocs:
6086661099
url: https://docs.datadoghq.com/service_management/on-call/
6086761100
name: On-Call
61101+
- description: Auto-generated tag On-Call Paging.
61102+
name: On-Call Paging
6086861103
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
6086961104

6087061105
directly through the Datadog API.'

‎examples/v2/on-call-paging/AcknowledgeOnCallPage.ts

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Acknowledge on call page returns "Accepted." response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.OnCallPagingApi(configuration);
9+
10+
const params: v2.OnCallPagingApiAcknowledgeOnCallPageRequest = {
11+
pageId: "15e74b8b-f865-48d0-bcc5-453323ed2c8f",
12+
};
13+
14+
apiInstance
15+
.acknowledgeOnCallPage(params)
16+
.then((data: any) => {
17+
console.log(
18+
"API called successfully. Returned data: " + JSON.stringify(data)
19+
);
20+
})
21+
.catch((error: any) => console.error(error));

‎examples/v2/on-call-paging/CreateOnCallPage.ts

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/**
2+
* Create on call page returns "OK." response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.OnCallPagingApi(configuration);
9+
10+
const params: v2.OnCallPagingApiCreateOnCallPageRequest = {
11+
body: {
12+
data: {
13+
attributes: {
14+
description: "Page details.",
15+
tags: ["service:test"],
16+
target: {
17+
identifier: "my-team",
18+
type: "team_handle",
19+
},
20+
title: "Page title",
21+
urgency: "low",
22+
},
23+
type: "pages",
24+
},
25+
},
26+
};
27+
28+
apiInstance
29+
.createOnCallPage(params)
30+
.then((data: v2.CreatePageResponse) => {
31+
console.log(
32+
"API called successfully. Returned data: " + JSON.stringify(data)
33+
);
34+
})
35+
.catch((error: any) => console.error(error));

‎examples/v2/on-call-paging/EscalateOnCallPage.ts

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Escalate on call page returns "Accepted." response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.OnCallPagingApi(configuration);
9+
10+
const params: v2.OnCallPagingApiEscalateOnCallPageRequest = {
11+
pageId: "15e74b8b-f865-48d0-bcc5-453323ed2c8f",
12+
};
13+
14+
apiInstance
15+
.escalateOnCallPage(params)
16+
.then((data: any) => {
17+
console.log(
18+
"API called successfully. Returned data: " + JSON.stringify(data)
19+
);
20+
})
21+
.catch((error: any) => console.error(error));

‎examples/v2/on-call-paging/ResolveOnCallPage.ts

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Resolve on call page returns "Accepted." response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.OnCallPagingApi(configuration);
9+
10+
const params: v2.OnCallPagingApiResolveOnCallPageRequest = {
11+
pageId: "15e74b8b-f865-48d0-bcc5-453323ed2c8f",
12+
};
13+
14+
apiInstance
15+
.resolveOnCallPage(params)
16+
.then((data: any) => {
17+
console.log(
18+
"API called successfully. Returned data: " + JSON.stringify(data)
19+
);
20+
})
21+
.catch((error: any) => console.error(error));

0 commit comments

Comments
 (0)