Get all case templates
https://{kibana_url}
- GET /api/cases/templates
- GET /s/{space_id}/api/cases/templates
Refer to Spaces for more information.
Returns a paginated list of case templates. Requires the Cases feature to be enabled in the space.
Query Parameters
-
pageinteger · default: 1 The page number to return.
-
perPageinteger · max: 100 · default: 20 The number of items to return. Limited to 100 items.
-
sortField· default: name Determines which field is used to sort the results.
-
Values:
templateIdnametemplateVersionownerdeletedAtauthorusageCountfieldCountlastUsedAtisDefaultisLatest -
searchstring An Elasticsearch simple_query_string query that filters the objects in the response.
-
owneroneOf A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.
-
Values:
casesobservabilitysecuritySolution Filters the returned templates by tags.
Filters the returned templates by author username.
-
isEnabledboolean Filters the returned templates by their enabled state.
Responses
Indicates a successful call.
-
pageintegerrequired -
The page number of the returned results.
-
perPageintegerrequired -
The number of results per page.
-
templatesobjectrequired -
The username of the template author.
-
definitionobjectrequired -
The parsed template definition.
-
definitionStringstring · max: 30000required -
The raw YAML definition string.
-
deletedAtstringrequired nullable -
The date the template was soft-deleted, or null if active.
-
descriptionstring · max: 30000 -
A human-readable description of the template.
-
fieldCountinteger -
The number of fields defined in the template.
-
fieldDefinitionsobject -
Metadata about each field defined in the template.
-
isDefaultboolean -
Whether this is the default template for its owner.
-
isEnabledboolean -
Whether the template is enabled.
-
isLatestbooleanrequired -
Whether this is the latest version of the template.
-
lastUsedAtstring -
The date the template was last used to create a case.
-
latestVersionintegerrequired -
The latest version number of this template.
-
namestring · max: 100required -
The display name of the template.
-
ownerstring · max: 50required -
The owning solution (e.g. cases, observability, securitySolution).
-
The words and phrases that help categorize templates. It can be an empty array.
-
templateIdstring · max: 36required -
The unique identifier of the template, shared across all versions.
-
templateVersionintegerrequired -
The version number of this template revision.
-
usageCountinteger -
The number of times this template has been used to create a case.
-
fieldSearchMatchesbooleanrequired -
Whether the search query matched a field name in this template.
-
totalintegerrequired -
The total number of templates matching the query.
Authorization information is missing or invalid.
-
errorstring -
messagestring -
statusCodeinteger