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 »

› › ›

Create saved objects API

edit

Create 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

edit

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

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 code

edit

200: Indicates a successful call.
409: Indicates a conflict error.

Example

edit

$ curl -X POST api/index_patterns/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.

Conflict errors

edit

Starting in Kibana 8.0, saved objects can exist in multiple spaces. As a result, you may encounter different types of conflict errors when attempting to create an object. If you encounter a 409 error that cannot be overridden by using the overwrite: true option, you are likely hitting a different type of conflict error. The Create API response is limited and does not include additional metadata. You can get more details about this error by using the Bulk create API instead.

« Find objects API Bulk create saved objects API »