Type to search.

Get all field definitions

Base URL
https://{kibana_url}
  • GET /api/cases/field_definitions
  • GET /s/{space_id}/api/cases/field_definitions
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Preview This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Returns a paginated list of field definitions (field library entries) for the given owner. Requires the Cases feature to be enabled in the space.

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

owner union string | string[] required

The application that owns the field definitions (for example cases, observability, or securitySolution). Required.

isGlobal boolean

When true, returns only global field definitions (rendered on every case). When false, returns all definitions. Omit to return all.

page integer · default: 1

The page number to return.

perPage integer · max: 100 · default: 20

The number of items to return. Limited to 100 items.

sortField enum

The field to sort by. When omitted, results are sorted by fieldDefinitionId ascending and sortOrder is ignored.

Values: name owner isGlobal displayOrder
sortOrder enum · default: desc

Determines the sort order.

Values: asc desc

A case-insensitive substring to match against each definition's name and description fields. Definitions where neither field contains the substring are excluded.

Responses

Indicates a successful call.

application/json
fieldDefinitions object[] required
definition string required

The field definition as a YAML string. New definitions are limited to 30 000 characters, but existing definitions created via internal tooling may be longer.

description string

Optional human-readable description of the field's purpose.

displayOrder integer · min: 0

Position of a global field in the case details view. Assigned by the server and changed via the Field Library reorder controls.

fieldDefinitionId string · max length: 36 required

Unique server-assigned identifier for the field definition (UUID). May be UUIDv4 for definitions created through the public API, or UUIDv5 for definitions created by internal migration processes.

isGlobal boolean

When true, this field is rendered in every case regardless of which template the case uses.

name string required

The field name. Must match the name property in the YAML definition and is unique per owner (case-insensitive). Immutable after creation.

owner string · max length: 50 required

The application that owns this field definition.

page integer · min: 1 required

The current page number.

perPage integer · min: 1 · max: 100 required

The number of items per page.

total integer · min: 0 required

The total number of field definitions matching the query (before pagination).