For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/incidents/update-an-incident-user-defined-role.md. A documentation index is available at /llms.txt.
Language
Datadog site

Update an incident user-defined role

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
PATCHhttps://api.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.us3.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.us5.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.datadoghq.eu/api/v2/incidents/config/user-defined-roles/{role_id}https://api.ap1.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.ap2.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.uk1.datadoghq.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.ddog-gov.com/api/v2/incidents/config/user-defined-roles/{role_id}https://api.us2.ddog-gov.com/api/v2/incidents/config/user-defined-roles/{role_id}

Overview

Update an existing user-defined role for incidents.

OAuth apps require the incident_settings_write authorization scope to access this endpoint.

Arguments

Path Parameters

Name
Type
Description
role_id [required]
string

The UUID of the incident user-defined role.

Query Strings

Name
Type
Description
include
string

Comma-separated list of related resources to include in the response.

Request

Body Data (required)

Field
Type
Description
data [required]
object

Data for updating an incident user-defined role.

Response

OK

Response with a single incident user-defined role.

Field
Type
Description
data [required]
object

Data for an incident user-defined role response.

included
[<oneOf>]

Included resources for an incident user-defined role response.

Code Example

Update an incident user-defined role
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF
# Path parameters
export role_id="00000000-0000-0000-0000-000000000002"

# 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 PATCH "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-roles/${role_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Tech Lead"
    },
    "id": "00000000-0000-0000-0000-000000000002",
    "type": "incident_user_defined_roles"
  }
}
EOF