NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.
Create Objectedit
This functionality is experimental and may be changed or removed completely in a future release.
The create saved object API enables you to persist a Kibana saved object.
Path Parametersedit
-
type
(required) -
(string) Valid options, include:
visualization
,dashboard
,search
,index-pattern
,config
, andtimelion-sheet
-
id
(optional) - (string) Enables specifying an ID to use, as opposed to one being randomly generated
Query Parametersedit
-
overwrite
(optional) - (boolean) If true, will overwrite the document with the same ID.
Request Bodyedit
-
attributes
(required) - (object) The data to persist
Examplesedit
The following example creates an index pattern object with a pattern of
my-pattern-*
.
POST api/saved_objects/index-pattern/my-pattern { "attributes": { "title": "my-pattern-*" } }
A successful call returns a response code of 200
and a response body
containing a JSON structure similar to the following example:
Known issuesedit
- Attributes are not validated at creation time. This means you can pass arbitrary and ill-formed data into this API that can break Kibana. Make sure any data you send to this API is properly formed.