Create an incident user-defined field
ADVERTENCIANote: 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/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-fieldsDescripción general
Create an incident user-defined field.
OAuth apps require the incident_settings_write authorization scope to access this endpoint.
Argumentos
Cadenas de consulta
Nombre
Type
Descripción
includestring
Comma-separated list of related resources to include. Supported values are "last_modified_by_user", "created_by_user", and "incident_type".
Solicitud
Body Data (required)
Incident user-defined field payload.
Campo
Type
Descripción
data [required]object
Data for creating an incident user-defined field.
attributes [required]object
Attributes for creating an incident user-defined field.
categoryenum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.
Allowed enum values:
what_happened, why_it_happenedcollectedenum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.
Allowed enum values:
active, stable, resolved, completeddefault_valuestring
The default value for the field. Must be one of the valid values when valid_values is set.
display_namestring
The human-readable name shown in the UI. Defaults to a formatted version of the name if not provided.
name [required]string
The unique identifier of the field. Must start with a letter or digit and contain only letters, digits, underscores, or periods.
ordinalstring
A decimal string representing the field's display order in the UI.
requiredboolean
When true, users must fill out this field on incidents.
tag_keystring
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]enum
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
Allowed enum values:
1, 2, 3, 4, 5, 6, 7, 8valid_values[object]
The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
descriptionstring
A detailed description of the valid value.
display_name [required]string
The human-readable display name for this value.
short_descriptionstring
A short description of the valid value.
value [required]string
The identifier that is stored when this option is selected.
relationships [required]object
Relationships for creating an incident user-defined field.
incident_type [required]object
Relationship to an incident type.
data [required]object
Relationship to incident type object.
id [required]string
The incident type's ID.
type [required]enum
Incident type resource type.
incident_typesAllowed enum values:
incident_typestype [required]enum
The incident user defined fields type.
Allowed enum values:
user_defined_field{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}Respuesta
CREATED
Response containing a single incident user-defined field.
Campo
Type
Descripción
data [required]object
Data object for an incident user-defined field response.
attributes [required]object
Attributes of an incident user-defined field.
category [required]enum
The section in which the field appears: "what_happened" or "why_it_happened". When null, the field appears in the Attributes section.
Allowed enum values:
what_happened, why_it_happenedcollected [required]enum
The lifecycle stage at which the app prompts users to fill out this field. Cannot be set on required fields.
Allowed enum values:
active, stable, resolved, completedcreated [required]date-time
Timestamp when the field was created.
default_value [required]string
The default value for the field.
deleted [required]date-time
Timestamp when the field was soft-deleted, or null if not deleted.
display_name [required]string
The human-readable name shown in the UI.
metadata [required]object
Metadata for autocomplete-type user-defined fields, describing how to populate autocomplete options.
category [required]string
The category of the autocomplete source.
search_limit_param [required]string
The query parameter used to limit the number of autocomplete results.
search_params [required]object
Additional query parameters to include in the search URL.
search_query_param [required]string
The query parameter used to pass typed input to the search URL.
search_result_path [required]string
The JSON path to the results in the response body.
search_url [required]string
The URL used to populate autocomplete options.
modified [required]date-time
Timestamp when the field was last modified.
name [required]string
The unique identifier of the field.
ordinal [required]string
A decimal string representing the field's display order in the UI.
required [required]boolean
When true, users must fill out this field on incidents.
reserved [required]boolean
When true, this field is reserved for system use and cannot be deleted.
tag_key [required]string
For metric tag-type fields only, the metric tag key that powers the autocomplete options.
type [required]int32
The data type of the field. 1=dropdown, 2=multiselect, 3=textbox, 4=textarray, 5=metrictag, 6=autocomplete, 7=number, 8=datetime.
valid_values [required][object]
The list of allowed values for dropdown, multiselect, and autocomplete fields.
descriptionstring
A detailed description of the valid value.
display_name [required]string
The human-readable display name for this value.
short_descriptionstring
A short description of the valid value.
value [required]string
The identifier that is stored when this option is selected.
id [required]string
The unique identifier of the user-defined field.
relationships [required]object
Relationships of an incident user-defined field.
created_by_user [required]object
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:
usersincident_type [required]object
Relationship to an incident type.
data [required]object
Relationship to incident type object.
id [required]string
The incident type's ID.
type [required]enum
Incident type resource type.
incident_typesAllowed enum values:
incident_typeslast_modified_by_user [required]object
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
The incident user defined fields type.
Allowed enum values:
user_defined_field{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"created": "2026-03-18T08:40:05.185406Z",
"default_value": "critical",
"deleted": null,
"display_name": "Root Cause",
"metadata": {
"category": "teams_and_services",
"search_limit_param": "page[size]",
"search_params": {},
"search_query_param": "filter",
"search_result_path": "$.data[*].attributes.name",
"search_url": "/api/v2/incidents/config/services"
},
"modified": "2026-03-18T08:40:05.185406Z",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"reserved": false,
"tag_key": null,
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
}
},
"type": "user_defined_field"
}
}Bad Request
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Unauthorized
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Campo
Type
Descripción
errors [required][object]
A list of errors.
detailstring
A human-readable explanation specific to this occurrence of the error.
metaobject
Non-standard meta-information about the error
sourceobject
References to the source of the error.
headerstring
A string indicating the name of a single request header which caused the error.
parameterstring
A string indicating which URI query parameter caused the error.
pointerstring
A JSON pointer to the value in the request document that caused the error.
statusstring
Status code of the response.
titlestring
Short human-readable summary of the error.
{
"errors": [
{
"detail": "Missing required attribute in body",
"meta": {},
"source": {
"header": "Authorization",
"parameter": "limit",
"pointer": "/data/attributes/title"
},
"status": "400",
"title": "Bad Request"
}
]
}Too many requests
API error response.
Campo
Type
Descripción
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Ejemplo de código
Create an incident user-defined field
# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOF# 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/config/user-defined-fields" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"category": "what_happened",
"collected": "active",
"default_value": "critical",
"display_name": "Root Cause",
"name": "root_cause",
"ordinal": "1.5",
"required": false,
"tag_key": "datacenter",
"type": 3,
"valid_values": [
{
"description": "A critical severity incident.",
"display_name": "Critical",
"short_description": "Critical",
"value": "critical"
}
]
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "user_defined_field"
}
}
EOFCreate an incident user-defined field
// Create an incident user-defined field returns "CREATED" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.IncidentUserDefinedFieldCreateRequest{
Data: datadogV2.IncidentUserDefinedFieldCreateData{
Attributes: datadogV2.IncidentUserDefinedFieldAttributesCreateRequest{
Category: *datadogV2.NewNullableIncidentUserDefinedFieldCategory(datadogV2.INCIDENTUSERDEFINEDFIELDCATEGORY_WHAT_HAPPENED.Ptr()),
Collected: *datadogV2.NewNullableIncidentUserDefinedFieldCollected(datadogV2.INCIDENTUSERDEFINEDFIELDCOLLECTED_ACTIVE.Ptr()),
DefaultValue: *datadog.NewNullableString(datadog.PtrString("critical")),
DisplayName: datadog.PtrString("Root Cause"),
Name: "root_cause",
Ordinal: *datadog.NewNullableString(datadog.PtrString("1.5")),
Required: datadog.PtrBool(false),
TagKey: *datadog.NewNullableString(datadog.PtrString("datacenter")),
Type: datadogV2.INCIDENTUSERDEFINEDFIELDFIELDTYPE_TEXTBOX,
ValidValues: []datadogV2.IncidentUserDefinedFieldValidValue{
{
Description: datadog.PtrString("A critical severity incident."),
DisplayName: "Critical",
ShortDescription: datadog.PtrString("Critical"),
Value: "critical",
},
},
},
Relationships: datadogV2.IncidentUserDefinedFieldCreateRelationships{
IncidentType: datadogV2.RelationshipToIncidentType{
Data: datadogV2.RelationshipToIncidentTypeData{
Id: "00000000-0000-0000-0000-000000000000",
Type: datadogV2.INCIDENTTYPETYPE_INCIDENT_TYPES,
},
},
},
Type: datadogV2.INCIDENTUSERDEFINEDFIELDTYPE_USER_DEFINED_FIELD,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
configuration.SetUnstableOperationEnabled("v2.CreateIncidentUserDefinedField", true)
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewIncidentsApi(apiClient)
resp, r, err := api.CreateIncidentUserDefinedField(ctx, body, *datadogV2.NewCreateIncidentUserDefinedFieldOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IncidentsApi.CreateIncidentUserDefinedField`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `IncidentsApi.CreateIncidentUserDefinedField`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Create an incident user-defined field
// Create an incident user-defined field returns "CREATED" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.IncidentsApi;
import com.datadog.api.client.v2.model.IncidentTypeType;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldAttributesCreateRequest;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldCategory;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldCollected;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateData;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateRelationships;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldCreateRequest;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldFieldType;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldResponse;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldType;
import com.datadog.api.client.v2.model.IncidentUserDefinedFieldValidValue;
import com.datadog.api.client.v2.model.RelationshipToIncidentType;
import com.datadog.api.client.v2.model.RelationshipToIncidentTypeData;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
defaultClient.setUnstableOperationEnabled("v2.createIncidentUserDefinedField", true);
IncidentsApi apiInstance = new IncidentsApi(defaultClient);
IncidentUserDefinedFieldCreateRequest body =
new IncidentUserDefinedFieldCreateRequest()
.data(
new IncidentUserDefinedFieldCreateData()
.attributes(
new IncidentUserDefinedFieldAttributesCreateRequest()
.category(IncidentUserDefinedFieldCategory.WHAT_HAPPENED)
.collected(IncidentUserDefinedFieldCollected.ACTIVE)
.defaultValue("critical")
.displayName("Root Cause")
.name("root_cause")
.ordinal("1.5")
.required(false)
.tagKey("datacenter")
.type(IncidentUserDefinedFieldFieldType.TEXTBOX)
.validValues(
Collections.singletonList(
new IncidentUserDefinedFieldValidValue()
.description("A critical severity incident.")
.displayName("Critical")
.shortDescription("Critical")
.value("critical"))))
.relationships(
new IncidentUserDefinedFieldCreateRelationships()
.incidentType(
new RelationshipToIncidentType()
.data(
new RelationshipToIncidentTypeData()
.id("00000000-0000-0000-0000-000000000000")
.type(IncidentTypeType.INCIDENT_TYPES))))
.type(IncidentUserDefinedFieldType.USER_DEFINED_FIELD));
try {
IncidentUserDefinedFieldResponse result = apiInstance.createIncidentUserDefinedField(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling IncidentsApi#createIncidentUserDefinedField");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Create an incident user-defined field
"""
Create an incident user-defined field returns "CREATED" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.incidents_api import IncidentsApi
from datadog_api_client.v2.model.incident_type_type import IncidentTypeType
from datadog_api_client.v2.model.incident_user_defined_field_attributes_create_request import (
IncidentUserDefinedFieldAttributesCreateRequest,
)
from datadog_api_client.v2.model.incident_user_defined_field_category import IncidentUserDefinedFieldCategory
from datadog_api_client.v2.model.incident_user_defined_field_collected import IncidentUserDefinedFieldCollected
from datadog_api_client.v2.model.incident_user_defined_field_create_data import IncidentUserDefinedFieldCreateData
from datadog_api_client.v2.model.incident_user_defined_field_create_relationships import (
IncidentUserDefinedFieldCreateRelationships,
)
from datadog_api_client.v2.model.incident_user_defined_field_create_request import IncidentUserDefinedFieldCreateRequest
from datadog_api_client.v2.model.incident_user_defined_field_field_type import IncidentUserDefinedFieldFieldType
from datadog_api_client.v2.model.incident_user_defined_field_type import IncidentUserDefinedFieldType
from datadog_api_client.v2.model.incident_user_defined_field_valid_value import IncidentUserDefinedFieldValidValue
from datadog_api_client.v2.model.relationship_to_incident_type import RelationshipToIncidentType
from datadog_api_client.v2.model.relationship_to_incident_type_data import RelationshipToIncidentTypeData
body = IncidentUserDefinedFieldCreateRequest(
data=IncidentUserDefinedFieldCreateData(
attributes=IncidentUserDefinedFieldAttributesCreateRequest(
category=IncidentUserDefinedFieldCategory.WHAT_HAPPENED,
collected=IncidentUserDefinedFieldCollected.ACTIVE,
default_value="critical",
display_name="Root Cause",
name="root_cause",
ordinal="1.5",
required=False,
tag_key="datacenter",
type=IncidentUserDefinedFieldFieldType.TEXTBOX,
valid_values=[
IncidentUserDefinedFieldValidValue(
description="A critical severity incident.",
display_name="Critical",
short_description="Critical",
value="critical",
),
],
),
relationships=IncidentUserDefinedFieldCreateRelationships(
incident_type=RelationshipToIncidentType(
data=RelationshipToIncidentTypeData(
id="00000000-0000-0000-0000-000000000000",
type=IncidentTypeType.INCIDENT_TYPES,
),
),
),
type=IncidentUserDefinedFieldType.USER_DEFINED_FIELD,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
configuration.unstable_operations["create_incident_user_defined_field"] = True
with ApiClient(configuration) as api_client:
api_instance = IncidentsApi(api_client)
response = api_instance.create_incident_user_defined_field(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Create an incident user-defined field
# Create an incident user-defined field returns "CREATED" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
config.unstable_operations["v2.create_incident_user_defined_field".to_sym] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
body = DatadogAPIClient::V2::IncidentUserDefinedFieldCreateRequest.new({
data: DatadogAPIClient::V2::IncidentUserDefinedFieldCreateData.new({
attributes: DatadogAPIClient::V2::IncidentUserDefinedFieldAttributesCreateRequest.new({
category: DatadogAPIClient::V2::IncidentUserDefinedFieldCategory::WHAT_HAPPENED,
collected: DatadogAPIClient::V2::IncidentUserDefinedFieldCollected::ACTIVE,
default_value: "critical",
display_name: "Root Cause",
name: "root_cause",
ordinal: "1.5",
required: false,
tag_key: "datacenter",
type: DatadogAPIClient::V2::IncidentUserDefinedFieldFieldType::TEXTBOX,
valid_values: [
DatadogAPIClient::V2::IncidentUserDefinedFieldValidValue.new({
description: "A critical severity incident.",
display_name: "Critical",
short_description: "Critical",
value: "critical",
}),
],
}),
relationships: DatadogAPIClient::V2::IncidentUserDefinedFieldCreateRelationships.new({
incident_type: DatadogAPIClient::V2::RelationshipToIncidentType.new({
data: DatadogAPIClient::V2::RelationshipToIncidentTypeData.new({
id: "00000000-0000-0000-0000-000000000000",
type: DatadogAPIClient::V2::IncidentTypeType::INCIDENT_TYPES,
}),
}),
}),
type: DatadogAPIClient::V2::IncidentUserDefinedFieldType::USER_DEFINED_FIELD,
}),
})
p api_instance.create_incident_user_defined_field(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Create an incident user-defined field
// Create an incident user-defined field returns "CREATED" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_incidents::CreateIncidentUserDefinedFieldOptionalParams;
use datadog_api_client::datadogV2::api_incidents::IncidentsAPI;
use datadog_api_client::datadogV2::model::IncidentTypeType;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldAttributesCreateRequest;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldCategory;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldCollected;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateData;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateRelationships;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldCreateRequest;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldFieldType;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldType;
use datadog_api_client::datadogV2::model::IncidentUserDefinedFieldValidValue;
use datadog_api_client::datadogV2::model::RelationshipToIncidentType;
use datadog_api_client::datadogV2::model::RelationshipToIncidentTypeData;
#[tokio::main]
async fn main() {
let body = IncidentUserDefinedFieldCreateRequest::new(IncidentUserDefinedFieldCreateData::new(
IncidentUserDefinedFieldAttributesCreateRequest::new(
"root_cause".to_string(),
IncidentUserDefinedFieldFieldType::TEXTBOX,
)
.category(Some(IncidentUserDefinedFieldCategory::WHAT_HAPPENED))
.collected(Some(IncidentUserDefinedFieldCollected::ACTIVE))
.default_value(Some("critical".to_string()))
.display_name("Root Cause".to_string())
.ordinal(Some("1.5".to_string()))
.required(false)
.tag_key(Some("datacenter".to_string()))
.valid_values(vec![IncidentUserDefinedFieldValidValue::new(
"Critical".to_string(),
"critical".to_string(),
)
.description("A critical severity incident.".to_string())
.short_description("Critical".to_string())]),
IncidentUserDefinedFieldCreateRelationships::new(RelationshipToIncidentType::new(
RelationshipToIncidentTypeData::new(
"00000000-0000-0000-0000-000000000000".to_string(),
IncidentTypeType::INCIDENT_TYPES,
),
)),
IncidentUserDefinedFieldType::USER_DEFINED_FIELD,
));
let mut configuration = datadog::Configuration::new();
configuration.set_unstable_operation_enabled("v2.create_incident_user_defined_field", true);
let api = IncidentsAPI::with_config(configuration);
let resp = api
.create_incident_user_defined_field(
body,
CreateIncidentUserDefinedFieldOptionalParams::default(),
)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runCreate an incident user-defined field
/**
* Create an incident user-defined field returns "CREATED" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
configuration.unstableOperations["v2.createIncidentUserDefinedField"] = true;
const apiInstance = new v2.IncidentsApi(configuration);
const params: v2.IncidentsApiCreateIncidentUserDefinedFieldRequest = {
body: {
data: {
attributes: {
category: "what_happened",
collected: "active",
defaultValue: "critical",
displayName: "Root Cause",
name: "root_cause",
ordinal: "1.5",
required: false,
tagKey: "datacenter",
type: 3,
validValues: [
{
description: "A critical severity incident.",
displayName: "Critical",
shortDescription: "Critical",
value: "critical",
},
],
},
relationships: {
incidentType: {
data: {
id: "00000000-0000-0000-0000-000000000000",
type: "incident_types",
},
},
},
type: "user_defined_field",
},
},
};
apiInstance
.createIncidentUserDefinedField(params)
.then((data: v2.IncidentUserDefinedFieldResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"