Create an incident responder
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}/respondershttps://api.us3.datadoghq.com/api/v2/incidents/{incident_id}/respondershttps://api.us5.datadoghq.com/api/v2/incidents/{incident_id}/respondershttps://api.datadoghq.eu/api/v2/incidents/{incident_id}/respondershttps://api.ap1.datadoghq.com/api/v2/incidents/{incident_id}/respondershttps://api.ap2.datadoghq.com/api/v2/incidents/{incident_id}/respondershttps://api.uk1.datadoghq.com/api/v2/incidents/{incident_id}/respondershttps://api.ddog-gov.com/api/v2/incidents/{incident_id}/respondershttps://api.us2.ddog-gov.com/api/v2/incidents/{incident_id}/respondersOverview
Add a responder to an incident.
OAuth apps require the incident_write authorization scope to access this endpoint.
Arguments
Path Parameters
Name
Type
Description
incident_id [required]string
The UUID of the incident.
Request
Body Data (required)
Incident responder payload.
Field
Type
Description
data [required]object
Incident responder data in a create request.
relationships [required]object
Relationships for creating an incident responder.
user [required]object
Relationship to a user for a responder create request.
data [required]object
A user relationship data object for creating a responder.
id [required]uuid
The user identifier.
type [required]string
The user resource type.
type [required]enum
Incident responder resource type.
Allowed enum values:
incident_responders{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}Response
Created
Response with a single incident responder.
Field
Type
Description
data [required]object
Incident responder data in a response.
attributes [required]object
Attributes of an incident responder in a response.
created [required]date-time
Timestamp when the responder was created.
external_idstring
The external ID of the responder.
external_sourcestring
The external source of the responder.
is_billable [required]boolean
Whether this responder counts toward billing.
last_activedate-time
Timestamp when the responder was last active.
metaobject
Additional metadata for the responder.
modified [required]date-time
Timestamp when the responder was last modified.
id [required]uuid
The responder identifier.
relationshipsobject
Relationships for an incident responder.
created_byobject
Relationship to user.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
userslast_modified_byobject
Relationship to user.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
usersrole_assignmentsobject
Relationship to role assignments for a responder.
data[object]
List of role assignment relationship data.
id [required]uuid
The role assignment identifier.
type [required]string
The role assignment resource type.
userobject
Relationship to user.
data [required]object
Relationship to user object.
id [required]string
A unique identifier that represents the user.
type [required]enum
Users resource type.
usersAllowed enum values:
userstype [required]enum
Incident responder resource type.
Allowed enum values:
incident_respondersincluded[object]
Included related resources.
attributesobject
Attributes of user object returned by the API.
emailstring
Email of the user.
handlestring
Handle of the user.
iconstring
URL of the user's icon.
namestring
Name of the user.
uuidstring
UUID of the user.
idstring
ID of the user.
typeenum
Users resource type.
usersAllowed enum values:
users{
"data": {
"attributes": {
"created": "2024-01-01T00:00:00.000Z",
"external_id": null,
"external_source": null,
"is_billable": true,
"last_active": "2024-01-01T00:00:00.000Z",
"meta": {},
"modified": "2024-01-01T00:00:00.000Z"
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"created_by": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"last_modified_by": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"role_assignments": {
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_role_assignments"
}
]
},
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "users"
}
}
},
"type": "incident_responders"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}Bad Request
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Unauthorized
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# 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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
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}/responders" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"relationships": {
"user": {
"data": {
"id": "00000000-0000-0000-0000-000000000001",
"type": "users"
}
}
},
"type": "incident_responders"
}
}
EOF