Docs
Kibana Guide [7.16] » REST API » Saved objects APIs » Create saved objects API
« Find objects API Bulk create saved objects API »

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.

Requestedit

POST <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 parametersedit

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.
<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, 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.
initialNamespaces

(Optional, string array) Identifiers for the spaces in which this object is created. If this is provided, the object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space (default behavior).

  • For shareable object types (registered with namespaceType: 'multiple'): this option can be used to specify one or more spaces, including the "All spaces" identifier ('*').
  • For isolated object types (registered with namespaceType: 'single' or namespaceType: 'multiple-isolated'): this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed.
  • For global object types (registered with `namespaceType: agnostic): this option cannot be used.

Response codeedit

200
Indicates a successful call.

Exampleedit

$ 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:

{
  "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 »