Create saved objects APIedit
[experimental] This functionality is experimental and may be changed or removed completely in a future release. Elastic will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. Create Kibana saved objects.
Path parametersedit
<type>
- (Required, string) Valid options include
visualization
,dashboard
,search
,index-pattern
,config
, andtimelion-sheet
. <id>
- (Optional, string) Specifies an ID instead of using a randomly generated ID.
Query parametersedit
overwrite
- (Optional, boolean) When true, overwrites the document with the same ID.
Request bodyedit
attributes
(Required, object) The data that you want to create.
When you create saved objects, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.
references
- (Optional, array) Objects with
name
,id
, andtype
properties that describe the other saved objects that this object references. Usename
in attributes to refer to the other saved object, but never theid
, which can update automatically during migrations or import/export.
Response codeedit
200
- Indicates a successful call.
Exampleedit
POST api/saved_objects/index-pattern/my-pattern { "attributes": { "title": "my-pattern-*" } }
The API returns the following: