For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ja/api/latest/incidents/update-an-incident-user-defined-field.md. A documentation index is available at /llms.txt.
homeホームdocsドキュメントapiAPI
Language
Datadog site

Update an incident user-defined field

警告Note: 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-fields/{field_id}https://api.us3.datadoghq.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.us5.datadoghq.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.datadoghq.eu/api/v2/incidents/config/user-defined-fields/{field_id}https://api.ap1.datadoghq.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.ap2.datadoghq.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.uk1.datadoghq.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.ddog-gov.com/api/v2/incidents/config/user-defined-fields/{field_id}https://api.us2.ddog-gov.com/api/v2/incidents/config/user-defined-fields/{field_id}

概要

Update an incident user-defined field.

This endpoint requires the incident_settings_write permission.

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

引数

パスパラメーター

名前
タイプ
説明
field_id [required]
string

The ID of the incident user-defined field.

クエリ文字列

名前
タイプ
説明
include
string

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

リクエスト

Body Data (required)

Incident user-defined field update payload.

フィールド
タイプ
説明
data [required]
object

Data for updating an incident user-defined field.

応答

OK

Response containing a single incident user-defined field.

フィールド
タイプ
説明
data [required]
object

Data object for an incident user-defined field response.

コード例

Update an incident user-defined field
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF
# Path parameters
export field_id="00000000-0000-0000-0000-000000000000"

# 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-fields/${field_id}" \
-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",
      "ordinal": "1.5",
      "required": false,
      "valid_values": [
        {
          "description": "A critical severity incident.",
          "display_name": "Critical",
          "short_description": "Critical",
          "value": "critical"
        }
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "user_defined_field"
  }
}
EOF