Upsert a markdown library item
https://{kibana_url}
- PUT /api/markdowns/{id}
- PUT /s/{space_id}/api/markdowns/{id}
Refer to Spaces for more information.
Replaces the full state of a markdown library item. Partial updates are not supported. To make incremental changes, retrieve the item first, modify the fields you need, then send the complete object back.
If no item exists with the specified ID, a new one is created.
Path Parameters
-
idstringrequired -
The unique ID of the markdown library item to be created or updated.
Request
-
contentstringrequired -
The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use
\nfor line breaks within JSON strings. -
descriptionstring -
A short description of the markdown library item.
-
settingsobject · default: { "open_links_in_new_tab": true } -
Display settings for the markdown panel.
-
open_links_in_new_tabboolean · default: true -
Open links in a new browser tab.
-
titlestring · min: 1required -
The markdown library item title.
Responses
updated
-
dataobjectrequired -
contentstringrequired -
The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use
\nfor line breaks within JSON strings. -
descriptionstring -
A short description of the markdown library item.
-
settingsobject · default: { "open_links_in_new_tab": true } -
Display settings for the markdown panel.
-
open_links_in_new_tabboolean · default: true -
Open links in a new browser tab.
-
titlestring · min: 1required -
The markdown library item title.
-
idstringrequired -
The unique ID of the markdown library item, as returned by the create or search endpoints.
-
metarequired -
created_atstring -
Timestamp when the object was created (ISO 8601).
-
created_bystring -
User profile ID of the user who created the object.
-
managedboolean -
When
true, the object is managed by Kibana and cannot be edited by users. -
ownerstring -
Identifier of the plugin or team that owns this object.
-
updated_atstring -
Timestamp when the object was last updated (ISO 8601).
-
updated_bystring -
User profile ID of the user who last updated the object.
-
versionstring -
Internal version identifier for optimistic concurrency control.
created
-
dataobjectrequired -
contentstringrequired -
The Markdown text rendered by the panel. Supports GitHub-flavored Markdown, including headings, paragraphs, lists, links, images, tables, blockquotes, and code blocks. Use
\nfor line breaks within JSON strings. -
descriptionstring -
A short description of the markdown library item.
-
settingsobject · default: { "open_links_in_new_tab": true } -
Display settings for the markdown panel.
-
open_links_in_new_tabboolean · default: true -
Open links in a new browser tab.
-
titlestring · min: 1required -
The markdown library item title.
-
idstringrequired -
The unique ID of the markdown library item, as returned by the create or search endpoints.
-
metarequired -
created_atstring -
Timestamp when the object was created (ISO 8601).
-
created_bystring -
User profile ID of the user who created the object.
-
managedboolean -
When
true, the object is managed by Kibana and cannot be edited by users. -
ownerstring -
Identifier of the plugin or team that owns this object.
-
updated_atstring -
Timestamp when the object was last updated (ISO 8601).
-
updated_bystring -
User profile ID of the user who last updated the object.
-
versionstring -
Internal version identifier for optimistic concurrency control.
invalid request
forbidden