mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
e9ed3a5a61
* Adds documentation for Saved Objects API Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co> * [DOCS] Moved Rest APIs in navigation * docs: revise rest api intro * docs: revise create object api details * docs: revise saved object api intro * docs: revise delete saved object api details * docs: remove newline character from api response * docs: get saved object api details * docs: update saved object api details * docs: fix title attribute in saved object api examples * docs: bulk-get saved object api details * docs: find saved object api details * docs: add index-pattern to valid types in api * docs: clarify sending multiple values in api * docs: note that savedObjects.find is not safe for export
46 lines
1.1 KiB
Text
46 lines
1.1 KiB
Text
[[saved-objects-api-get]]
|
|
=== Get Object
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
The get saved object API enables you to retrieve a single Kibana saved object
|
|
by id.
|
|
|
|
==== Request
|
|
|
|
`GET /api/saved_objects/<type>/<id>`
|
|
|
|
==== Path Parameters
|
|
|
|
`type` (required)::
|
|
(string) Valid options, include: `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`
|
|
|
|
`id` (required)::
|
|
(string) ID of object to retrieve
|
|
|
|
|
|
==== Examples
|
|
|
|
The following example retrieves the index pattern object with an id of
|
|
`my-pattern`.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET api/saved_objects/index-pattern/my-pattern
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
A successful call returns a response code of `200` and a response body
|
|
containing a JSON structure similar to the following example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"id": "my-pattern",
|
|
"type": "index-pattern",
|
|
"version": 1,
|
|
"attributes": {
|
|
"title": "my-pattern-*"
|
|
}
|
|
}
|
|
--------------------------------------------------
|