Get a case template by ID

Base URL: https://{kibana_url}

GET /api/cases/templates/{template_id}
GET /s/{space_id}/api/cases/templates/{template_id}

Refer to Spaces for more information.

Returns the details of a case template. Requires the Cases feature to be enabled in the space.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Query parameters

Responses

Indicates a successful call.

application/json

author string · max length: 1000: The username of the template author.
definition object required: The parsed template definition.
definitionString string · max length: 30000 required: The raw YAML definition string.
deletedAt string · format: date-time required nullable: The date the template was soft-deleted, or null if active.
description string · max length: 30000: A human-readable description of the template.
fieldCount integer: The number of fields defined in the template.
fieldDefinitions object[]: Metadata about each field defined in the template.
isDefault boolean: Whether this is the default template for its owner.
isEnabled boolean: Whether the template is enabled.
isLatest boolean required: Whether this is the latest version of the template.
lastUsedAt string · format: date-time: The date the template was last used to create a case.
latestVersion integer required: The latest version number of this template.
name string · max length: 100 required: The display name of the template.
owner string · max length: 50 required: The owning solution (e.g. cases, observability, securitySolution).
tags string[] · max items: 200: The words and phrases that help categorize templates. It can be an empty array.
templateId string · max length: 36 required: The unique identifier of the template, shared across all versions.
templateVersion integer required: The version number of this template revision.
usageCount integer: The number of times this template has been used to create a case.

Authorization information is missing or invalid.

application/json

The template was not found.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/cases/templates/9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/cases/templates/9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "definition": {},
  "definitionString": "fields: []",
  "deletedAt": "null",
  "isLatest": true,
  "latestVersion": 1,
  "name": "My Template",
  "owner": "cases",
  "templateId": "9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42",
  "templateVersion": 1
}

{
  "error": "Unauthorized",
  "message": "Unable to authenticate with the provided credentials.",
  "statusCode": 401
}

{
  "error": "Not Found",
  "message": "Saved object [cases-template/9da1ea2a-09f8-4d0e-bf9d-09bf8c9d0f42] not found",
  "statusCode": 404
}