Create a markdown library item

Base URL
https://{kibana_url}
  • POST /api/markdowns
Auth

Creates a new markdown library item and returns its ID, full state, and metadata.

Header parameters

kbn-xsrf string required

A required header to protect against CSRF attacks

Request body

content string required

The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use \n for line breaks within JSON strings.

description string

A short description of the markdown library item.

settings object · default: { "open_links_in_new_tab": true }

Display settings for the markdown panel.

Open links in a new browser tab.

title string · min length: 1 required

The markdown library item title.

Responses

created

application/json
data object required
content string required

The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use \n for line breaks within JSON strings.

description string

A short description of the markdown library item.

settings object · default: { "open_links_in_new_tab": true }

Display settings for the markdown panel.

Open links in a new browser tab.

title string · min length: 1 required

The markdown library item title.

id string required

The unique ID of the markdown library item, as returned by the create or search endpoints.

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.

400

invalid request

403

forbidden

Base URL
https://{kibana_url}