Links

Upsert links 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/links/{id}</span></div>

Refer to Spaces for more information.

Replaces the full state of a links 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/links/{id}

Request

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

Path parameters

idstring required

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

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

descriptionstring
layout'horizontal' | 'vertical'

Whether to display the links in a horizontal or vertical layout.

tagsstring[]

Tag IDs associated with this library item.

titlestring required

Response

updated

idstring required

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

Changes

  • f2afbecbddc3Revision changes
    • info

      the request property default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status