cases

Get all case templates

Spaces method and path for this operation:

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

Refer to Spaces for more information.

Returns a paginated list of case templates. Requires the Cases feature to be enabled in the space.

get/api/cases/templates

Query parameters

pageinteger

The page number to return.

perPageinteger

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

sortField'templateId' | 'name' | 'templateVersion' | 'owner' | 'deletedAt' | 'author' | 'usageCount' | 'fieldCount' | 'lastUsedAt' | 'isDefault' | 'isLatest'

Determines which field is used to sort the results.

sortOrder'asc' | 'desc'

Determines the sort order.

searchstring

An Elasticsearch simple_query_string query that filters the objects in the response.

'cases' | 'observability' | 'securitySolution'

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

OR
CasesOwner[]
Example:cases

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.

string
OR
CasesString[]

Filters the returned templates by tags.

string
OR
CasesString[]

Filters the returned templates by author username.

isEnabledboolean

Filters the returned templates by their enabled state.

Response

Indicates a successful call.

pageinteger required

The page number of the returned results.

perPageinteger required

The number of results per page.

totalinteger required

The total number of templates matching the query.

Changes

No recorded changes to this endpoint across all 92 revisions of this API.