Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.ap2.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.datadoghq.eu/api/v2/incidents/{incident_id}/cases/pagehttps://api.ddog-gov.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.us2.ddog-gov.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.uk1.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.us3.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.us5.datadoghq.com/api/v2/incidents/{incident_id}/cases/page
Overview
Create a page from an incident using the Cases service.
This endpoint requires
all
of the following permissions:
oncall_pageincident_writeOAuth apps require the incident_write authorization scope to access this endpoint.
Arguments
Path Parameters
The UUID of the incident.
Request
Body Data (required)
Page creation payload.
Expand All
Page data in a create request.
Attributes for creating a page from an incident.
The description of the page.
The public ID of the incident.
A reference to an incident role for a page.
The type of incident role for a page.
Allowed enum values: incident_user_defined_roles,incident_reserved_roles
List of affected services.
List of tags for the page.
The target recipient for a page.
The identifier of the target (handle, UUID, or user UUID).
The type of target for a page request.
Allowed enum values: team_handle,team_uuid,user_uuid
Resource type for a page creation request.
Allowed enum values: page
{
"data": {
"attributes": {
"description": "A critical incident affecting production systems.",
"incident_public_id": "12345",
"role": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_user_defined_roles"
},
"services": [
"web-store",
"checkout"
],
"tags": [
"env:prod"
],
"target": {
"identifier": "my-team-handle",
"type": "team_uuid"
},
"title": "Production outage - SEV-1"
},
"type": "page"
}
}
Response
OK
Response with a page UUID.
Expand All
Page UUID data in a response.
The UUID of the created page.
Resource type for a page UUID response.
Allowed enum values: page_uuid
{
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "page_uuid"
}
}
Bad Request
{
"errors": [
"Bad Request"
]
}
Unauthorized
{
"errors": [
"Bad Request"
]
}
Forbidden
{
"errors": [
"Bad Request"
]
}
Not Found
{
"errors": [
"Bad Request"
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
## default
#
# Path parameters
export incident_id="CHANGE_ME"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"description": "A critical incident affecting production systems.",
"services": [
"web-store"
],
"tags": [
"env:prod"
],
"target": {
"identifier": "my-oncall-team",
"type": "team_handle"
},
"title": "Production outage - SEV-1"
},
"type": "page"
}
}
EOF
