Create saved objects API
editCreate saved objects API
edit[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Create Kibana saved objects.
Request
editPOST <kibana host>:<port>/api/saved_objects/<type>
POST <kibana host>:<port>/api/saved_objects/<type>/<id>
POST <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>
POST <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>/<id>
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used. -
<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 parameters
edit-
overwrite
- (Optional, boolean) When true, overwrites the document with the same ID.
Request body
edit-
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 code
edit-
200
- Indicates a successful call.
Example
edit$ curl -X POST api/saved_objects/index-pattern/my-pattern -H 'kbn-xsrf: true' -H 'Content-Type: application/json' -d ' { "attributes": { "title": "my-pattern-*" } }'
The API returns the following: