IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Find objects API Bulk create saved objects API »
Elastic Docs ›Kibana Guide [7.4] ›REST API ›Saved objects APIs

Create saved object API

edit

Create saved object 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 a Kibana saved object.

Request

edit

POST /api/saved_objects/<type>

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

POST /s/<space_id>/saved_objects/<type>

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, and timelion-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, and type properties that describe the other saved objects that this object references. Use name in attributes to refer to the other saved object, but never the id, which can update automatically during migrations or import/export.

Response code

edit
200
Indicates a successful call.

Example

edit
POST api/saved_objects/index-pattern/my-pattern
{
  "attributes": {
    "title": "my-pattern-*"
  }
}

The API returns the following:

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

When my-pattern is unspecified in the path, a unique ID is automatically generated.
« Find objects API Bulk create saved objects API »