Sign in
cases

Update a case template

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/cases/templates/{template_id}</span></div>

Refer to Spaces for more information.

Fully replaces a case template. Every accepted update creates a new template version; previous versions stay retrievable with the version query parameter of the get template API, and cases keep the version they were created with. You must have the "Manage templates" sub-privilege for the Cases feature of the owning solution. Set dry_run=true to run the full validation without writing. Requires the Cases feature to be enabled in the space.

put/api/cases/templates/{template_id}

Path parameters

template_idstring required

The identifier for the template.

Query parameters

dry_runboolean

When true, validates the request without updating the template and returns {"valid": true}.

Request body

definitionstring required

The template definition as a YAML string: case defaults (name, severity, category, tags, assignees, connector, settings) and a fields array of inline field definitions or $ref entries pointing into the owner's field library. Stored field values appear on cases under extended_fields keys shaped <field_name>_as_<storage_type>.

descriptionstring

A description of the template.

isEnabledboolean

Disabled templates are hidden from the case creation flow.

namestring

The template identity name, unique per owner (case-insensitive). May be omitted when the YAML definition provides a case-default title (name:), which is then used as the identity name.

owner'cases' | 'observability' | 'securitySolution' required

The application that owns the cases: Stack Management, Observability, or Elastic Security.

tagsstring[]

The words and phrases that help categorize templates. It can be an empty array.

Example request

{
  "definition": "name: Security incident\nseverity: high\ntags: [security]\nfields:\n  - name: priority\n    label: Priority\n    type: keyword\n    control: SELECT_BASIC\n    metadata:\n      options: [low, medium, high]\n      default: medium\n  - $ref: risk_score\n",
  "owner": "cases"
}

Response

Indicates a successful call. Returns the new template version, or {"valid": true} for a dry run.

OR

Changes

Changed in 1 of the 97 revisions of this API.1