Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Incidents

Create an incident user-defined field

Create an incident user-defined field.

post/api/v2/incidents/config/user-defined-fields

Query parameters

includestring

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

Request body

Example request

{
  "data": {
    "attributes": {
      "category": "what_happened",
      "collected": "active",
      "default_value": "critical",
      "display_name": "Root Cause",
      "name": "root_cause",
      "ordinal": "1.5",
      "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"
  }
}

Response

CREATED

Example response

{
  "data": {
    "attributes": {
      "category": "what_happened",
      "collected": "active",
      "created": "2026-03-18T08:40:05.185406Z",
      "default_value": "critical",
      "display_name": "Root Cause",
      "metadata": {
        "category": "teams_and_services",
        "search_limit_param": "page[size]",
        "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",
      "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"
  }
}