2018-05-30 18:27:48 +02:00
[[saved-objects-api-create]]
2019-10-16 22:10:40 +02:00
=== Create saved objects API
2019-09-06 18:09:57 +02:00
++++
2019-10-16 22:10:40 +02:00
<titleabbrev>Create saved objects</titleabbrev>
2019-09-06 18:09:57 +02:00
++++
2018-05-30 18:27:48 +02:00
2019-10-16 22:10:40 +02:00
experimental[] Create {kib} saved objects.
2018-12-05 22:20:58 +01:00
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-request]]
2018-05-30 18:27:48 +02:00
==== Request
`POST /api/saved_objects/<type>` +
`POST /api/saved_objects/<type>/<id>`
2019-10-18 19:17:54 +02:00
`POST /s/<space_id>/saved_objects/<type>`
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-path-params]]
==== Path parameters
2018-05-30 18:27:48 +02:00
2019-10-18 19:17:54 +02:00
`space_id`::
(Optional, string) An identifier for the space. If `space_id` is not provided in the URL, the default space is used.
2019-09-06 18:09:57 +02:00
`<type>`::
(Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
`<id>`::
(Optional, string) Specifies an ID instead of using a randomly generated ID.
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-query-params]]
==== Query parameters
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
`overwrite`::
(Optional, boolean) When true, overwrites the document with the same ID.
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-request-body]]
==== Request body
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
`attributes`::
(Required, object) The data that you want to create.
+
WARNING: 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 {kib}. Make sure
any data that you send to the API is properly formed.
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
`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.
2018-05-30 18:27:48 +02:00
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-request-codes]]
==== Response code
2018-05-30 18:27:48 +02:00
2019-10-18 19:17:54 +02:00
`200`::
2019-09-06 18:09:57 +02:00
Indicates a successful call.
2019-10-18 19:17:54 +02:00
2019-09-06 18:09:57 +02:00
[[saved-objects-api-create-example]]
==== Example
2018-05-30 18:27:48 +02:00
[source,js]
--------------------------------------------------
POST api/saved_objects/index-pattern/my-pattern
{
"attributes": {
"title": "my-pattern-*"
}
}
--------------------------------------------------
// KIBANA
2019-09-06 18:09:57 +02:00
The API returns the following:
2018-05-30 18:27:48 +02:00
[source,js]
--------------------------------------------------
{
"id": "my-pattern", <1>
"type": "index-pattern",
"version": 1,
"attributes": {
"title": "my-pattern-*"
}
}
--------------------------------------------------
2019-09-06 18:09:57 +02:00
<1> When `my-pattern` is unspecified in the path, a unique ID is automatically generated.