Markdowns

Upsert a markdown library item

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb put">put</span>&nbsp;<span class="operation-path">/s/{space_id}/api/markdowns/{id}</span></div>

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.

put/api/markdowns/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/markdowns/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

The unique ID of the markdown library item to be created or updated.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

contentstring 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.

descriptionstring

A short description of the markdown library item.

titlestring required

The markdown library item title.

Response

updated

idstring required

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

Changes

  • f2afbecbddc3Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      the request property became optional

    • info

      the request property default value {"open_links_in_new_tab":true} was added

    • info

      the response's property default value {"open_links_in_new_tab":true} was added for the status

    • info

      the response's property default value {"open_links_in_new_tab":true} was added for the status