IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Create Object

edit

Create Object

edit

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.

Request

edit

POST /api/saved_objects/<type>

POST /api/saved_objects/<type>/<id>

Path Parameters

edit

type (required): (string) Valid options, include: visualization, dashboard, search, index-pattern, config, and timelion-sheet
id (optional): (string) Enables specifying an ID to use, as opposed to one being randomly generated

Query Parameters

edit

overwrite (optional): (boolean) If true, will overwrite the document with the same ID.

Request Body

edit

attributes (required): (object) The data to persist

Examples

edit

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:

{
  "id": "my-pattern", 
  "type": "index-pattern",
  "version": 1,
  "attributes": {
    "title": "my-pattern-*"
  }
}

If my-pattern was not specified in the path, a unique ID would have been generated.

Known issues

edit

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.

« Find Objects Update Object »