For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/incidents/get-a-list-of-incident-user-defined-fields.md. A documentation index is available at /llms.txt.
Language
Datadog site

Get a list of incident user-defined fields

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

Overview

Get a list of all incident user-defined fields.

This endpoint requires the incident_read permission.

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

Arguments

Query Strings

Name
Type
Description
page[size]
integer

The number of results to return per page. Must be between 0 and 1000.

Default: 1000
page[number]
integer

The page number to retrieve, starting at 0.

Default: 0
include-deleted
boolean

When true, include soft-deleted fields in the response.

Default: false
filter[incident-type]
string

Filter results to fields associated with the given incident type UUID.

include
string

Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".

Response

OK

Response containing a list of incident user-defined fields.

Field
Type
Description
data [required]
[object]

An array of user-defined field objects.

meta [required]
object

Pagination metadata for the user-defined field list response.

Code Example

Get a list of incident user-defined fields
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# 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 GET "https://api.${DD_SITE}/api/v2/incidents/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"