Kibana 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.
Kibana saved objects API is one of 60 APIs that Kibana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include saved objects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 16 operations across 13 paths, and defines 1 schema. It is described by OpenAPI 3.0.3.
Requests are made against a single base URL, https://{kibana_url}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Kibana saved objects API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
It accepts HTTP basic authentication (basicAuth).
By default, every request must be authenticated.
apiKeyAuth— These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64A…
Paths & Operations 16
Across 13 paths, the API surfaces 16 operations — 1 DELETE, 3 GET, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
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 m…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Saved_objects_400_response (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kibana 12
Other APIs Kibana publishes across the network.