Elastic Stack

Elastic Stack (ELK Stack) saved objects API

Export sets of saved objects that you want to import into Kibana, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs. To manage a specific type of saved object, use the corresponding APIs. For example, use: * [Data views](../group/endpoint-data-views) * [Spaces](../group/endpoint-spaces) * [Short URLs](../group/endpoint-short-url) Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.

GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/encrypted_saved_objects/_rotate_key Rotate the encryption key for saved objects · Rotate a key for encrypted saved objects #
Ask an LLM
“How do I re-encrypt Kibana saved objects with the current primary key?”
“Can I limit encryption key rotation to one saved object type?”
Tell an agent
Rotate the encryption key for all encrypted saved objects.
Rotate the encryption key only for saved objects of type {type} in batches of {batch_size}.
POST /api/saved_objects/_bulk_create Create many saved objects at once (legacy) · Create saved objects #
Ask an LLM
“How do I create several Kibana saved objects in a single request?”
“Can a bulk create overwrite objects that already have the same type and ID?”
Tell an agent
Bulk create these saved objects in Kibana using the legacy bulk create endpoint.
Bulk create saved objects with overwrite set to {overwrite}.
POST /api/saved_objects/_bulk_delete Delete many saved objects at once (legacy) · Delete saved objects #
Ask an LLM
“How do I delete a batch of Kibana saved objects in one call?”
“Can I force-delete multi-space saved objects from every space?”
Tell an agent destructive · confirm first
Bulk delete this list of saved objects.
Bulk delete saved objects from all spaces with force set to {force}.
POST /api/saved_objects/_bulk_get Fetch many saved objects by type and ID · Get saved objects #
Ask an LLM
“How do I fetch several saved objects by type and ID at once?”
“Can I retrieve a batch of dashboards and visualizations in one request?”
Tell an agent
Bulk get these saved objects by type and ID.
Fetch this batch of saved objects in one request.
POST /api/saved_objects/_bulk_resolve Resolve many saved objects via legacy aliases · Resolve saved objects #
Ask an LLM
“How do I look up several saved objects whose IDs may have changed after an upgrade?”
“Can bulk resolve follow legacy URL aliases?”
Tell an agent
Bulk resolve these saved object IDs, following legacy URL aliases.
Resolve this batch of old saved object IDs to their current objects.
PUT /api/saved_objects/_bulk_update Update many saved objects at once (legacy) · Update saved objects #
Ask an LLM
“How do I update several saved objects in one request?”
“Is the bulk update endpoint for saved objects deprecated?”
Tell an agent
Bulk update these saved objects with their new attributes.
Apply attribute changes to this batch of saved objects in one call.
POST /api/saved_objects/_export Export saved objects to a file · Export saved objects #
Ask an LLM
“How do I back up my Kibana dashboards to a file?”
“Can I include every referenced object when exporting saved objects?”
Tell an agent
Export all saved objects of type {type}.
Export saved objects {objects} including everything they reference.
GET /api/saved_objects/_find Search saved objects · Search for saved objects #
Ask an LLM
“How do I find saved objects of a given type by title?”
“Can I filter saved objects with a KQL query?”
Tell an agent
Find saved objects of type {type} matching {search}.
Search {type} saved objects with filter {filter}, {per_page} per page.
POST /api/saved_objects/_import Import saved objects from an export file · Import saved objects #
Ask an LLM
“How do I restore dashboards from an exported file?”
“Can I import saved objects as new copies instead of overwriting?”
Tell an agent
Import saved objects from file {file}.
Import {file} and overwrite any existing saved objects.
POST /api/saved_objects/_resolve_import_errors Resolve errors from a saved objects import · Resolve import errors #
Ask an LLM
“How do I fix conflicts from a failed saved objects import?”
“Can I retry specific objects and remap references after an import error?”
Tell an agent
Resolve import errors for file {file} using retries {retries}.
Retry the failed objects {retries} from import file {file}.
POST /api/saved_objects/{type} Create a saved object with a generated ID · Create a saved object #
Ask an LLM
“How do I create a single saved object and let Kibana pick its ID?”
“Can I create a saved object directly into specific spaces?”
Tell an agent
Create a {type} saved object with attributes {attributes} and an auto-generated ID.
Create a new {type} object with {attributes} in spaces {initialNamespaces}.
DELETE /api/saved_objects/{type}/{id} Delete a single saved object · Delete a saved object #
Ask an LLM
“How do I delete one saved object by type and ID?”
“Can I remove a shared saved object from all spaces at once?”
Tell an agent destructive · confirm first
Delete the {type} saved object {id}.
Force delete saved object {id} of type {type} from every space.
GET /api/saved_objects/{type}/{id} Get a saved object by type and ID · Get a saved object #
Ask an LLM
“How do I fetch one saved object when I know its type and ID?”
“Where can I read the attributes of a single dashboard?”
Tell an agent
Get the {type} saved object {id}.
Show saved object {id} of type {type}.
POST /api/saved_objects/{type}/{id} Create a saved object with a chosen ID · Create a saved object #
Ask an LLM
“How do I create a saved object with an ID I choose myself?”
“Can I overwrite an existing object when creating one with a specific ID?”
Tell an agent
Create a {type} saved object with ID {id} and attributes {attributes}.
Create {type} object {id} with {attributes}, overwriting any existing one.
PUT /api/saved_objects/{type}/{id} Update a single saved object · Update a saved object #
Ask an LLM
“How do I change the attributes of one existing saved object?”
“Can an update create the object if it doesn't exist yet?”
Tell an agent
Update {type} saved object {id} with attributes {attributes}.
Change saved object {id} of type {type} to {attributes}, upserting if missing.
GET /api/saved_objects/resolve/{type}/{id} Resolve one saved object via legacy alias · Resolve a saved object #
Ask an LLM
“How do I open a saved object whose ID changed after a Kibana upgrade?”
“Does resolving a saved object follow a legacy URL alias?”
Tell an agent
Resolve {type} saved object {id}, following any legacy URL alias.
Find the current {type} object for old ID {id}.

Documentation

📖
Documentation
https://www.elastic.co/docs/reference/elasticsearch
📖
APIReference
https://www.elastic.co/docs/api/doc/elasticsearch/
📖
Documentation
https://www.elastic.co/docs/reference/kibana
📖
APIReference
https://www.elastic.co/docs/api/doc/kibana/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-saved-objects-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/elastic/elasticsearch-specification
🔗
SourceCode
https://github.com/elastic/kibana
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/mcp/elk-stack-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-saved-objects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elk-stack-saved-objects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    name: Kibana Team
  description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
  title: Kibana saved objects API
  version: ''
  x-doc-license:
    name: Attribution-NonCommercial-NoDerivatives 4.0 International
    url: https://creativecommons.org/licenses/by-nc-nd/4.0/
  x-feedbackLink:
    label: Feedback
    url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
  variables:
    kibana_url:
      default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:


# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-saved-objects-api-openapi.yml