Create a page from an incident
WARNINGNote: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST
https://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/pagehttps://api.datadoghq.eu/api/v2/incidents/{incident_id}/cases/pagehttps://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.ap2.datadoghq.com/api/v2/incidents/{incident_id}/cases/pagehttps://api.uk1.datadoghq.com/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/pagePrésentation
Create a page from an incident using the Cases service.
Deprecated: This endpoint is deprecated. Use Create an on-call page from an incident instead.
OAuth apps require the incident_write authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Name
Type
Description
incident_id [required]string
The UUID of the incident.
Requête
Body Data (required)
Page creation payload.
Champ
Type
Description
data [required]object
Page data in a create request.
attributes [required]object
Attributes for creating a page from an incident.
descriptionstring
The description of the page.
incident_public_idstring
The public ID of the incident.
roleobject
A reference to an incident role for a page.
id [required]uuid
The role identifier.
type [required]enum
The type of incident role for a page.
Allowed enum values:
incident_user_defined_roles, incident_reserved_rolesservices[string]
List of affected services.
tags[string]
List of tags for the page.
targetobject
The target recipient for a page.
identifier [required]string
The identifier of the target (handle, UUID, or user UUID).
type [required]enum
The type of target for a page request.
Allowed enum values:
team_handle, team_uuid, user_uuidtitlestring
The title of the page.
type [required]enum
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"
}
}Réponse
OK
Response with a page UUID.
Champ
Type
Description
data [required]object
Page UUID data in a response.
id [required]uuid
The UUID of the created page.
type [required]enum
Resource type for a page UUID response.
Allowed enum values:
page_uuid{
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "page_uuid"
}
}Bad Request
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Unauthorized
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
Create a page from an incident
# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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# Path parameters
export incident_id="CHANGE_ME"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/incidents/${incident_id}/cases/page" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-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