Type to search.

List markdown library items

Base URL
https://{kibana_url}
  • GET /api/markdowns
Auth The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Planned We plan to add this functionality in a future Elastic Stack update. Subject to changes. 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 markdown library items. Each result includes title, description, and metadata, but not the content. Use GET /api/markdowns/{id} to retrieve the complete state.

Query parameters

page number · min: 1 · default: 1

The page of results to return.

per_page number · min: 1 · max: 1000 · default: 20

The number of results to return per page.

query string

Filters results by title and description using Elasticsearch simple_query_string syntax. Multi-word terms require all words to match.

Responses

success

application/json
data object[] · min items: 0 · max items: 1000 required

List of markdown library items matching the query.

data object required
description string

A short description of the markdown library item.

title string required

The markdown library item title.

id string required

The markdown library item ID.

meta object required
created_at string

Timestamp when the object was created (ISO 8601).

created_by string

User profile ID of the user who created the object.

managed boolean

When true, the object is managed by Kibana and cannot be edited by users.

owner string

Identifier of the plugin or team that owns this object.

updated_at string

Timestamp when the object was last updated (ISO 8601).

updated_by string

User profile ID of the user who last updated the object.

version string

Internal version identifier for optimistic concurrency control.

meta object required
page number · min: 1 · default: 1

The returned page of results.

per_page number · min: 1 · max: 1000 · default: 20

The number of results returned per page.

total number required

The total number of results matching the query.

403

forbidden