Update a field definition
- Base URL
-
https://{kibana_url}
- PUT /api/cases/field_definitions/{field_definition_id}
- PUT /s/{space_id}/api/cases/field_definitions/{field_definition_id}
Refer to Spaces for more information.
Updates editable attributes of a field definition. Server-managed attributes (displayOrder, legacyKey) are preserved. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution. A field's name and YAML type are immutable after creation — an attempt to change either returns 409 with attributes.code = "field_identity_immutable" and attributes.changed listing which identity attributes were modified. Setting isGlobal to false when the field is linked to an active custom field in the Cases configuration returns 409; otherwise demotion is allowed. Requires the Cases feature to be enabled in the space. Use dry_run=true to validate the request without writing anything.
Request body
-
definitionstring · max length: 1000000required -
The field definition as a YAML string describing a single field (type, label, control, metadata).
-
isGlobalboolean -
When true, this field is rendered in every case for this owner, regardless of the template used. Global fields cannot be demoted (set to false) while they are linked to an active custom field in the Cases configuration.
-
namestring · min length: 1 · max length: 1000 -
The field name, unique per owner (case-insensitive). Must match the
namekey inside the YAML definition. When omitted, the name is extracted from the definition YAML automatically. Immutable after creation. Unlike POST, the 50-character limit is not enforced on PUT so that definitions with legacy names that exceed the limit remain modifiable.
Responses
Indicates a successful call. Returns the updated field definition, or { "valid": true } when dry_run=true.
The request body is invalid, the YAML definition is malformed, the name does not match the YAML definition's name, or the owner would be changed.
Authorization information is missing or invalid.
The user does not have the manage templates privilege for the owner.
A field's name or type cannot be changed after creation, or a global field cannot be demoted while linked to an active custom field.