IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Saved objects APIs Bulk get objects API »

› › ›

Get object API

edit

Get 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. Retrieve a single Kibana saved object by ID.

Request

edit

GET <kibana host>:<port>/api/saved_objects/<type>/<id>

GET <kibana host>:<port>/s/<space_id>/api/saved_objects/<type>/<id>

GET /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, and timelion-sheet.
id: (Required, string) The ID of the object to retrieve.

Response code

edit

200: Indicates a successful call.

Example

edit

Retrieve the index pattern object with the my-pattern ID:

$ curl -X GET api/index_patterns/index-pattern/my-pattern

The API returns the following:

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

Retrieve a dashboard object in the testspace by ID:

$ curl -X GET s/testspace/api/saved_objects/dashboard/7adfa750-4c81-11e8-b3d7-01146121b73d

The API returns the following:

{
  "id": "7adfa750-4c81-11e8-b3d7-01146121b73d",
  "type": "dashboard",
  "updated_at": "2019-07-23T00:11:07.059Z",
  "version": "WzQ0LDFd",
  "attributes": {
    "title": "[Flights] Global Flight Dashboard",
    "hits": 0,
    "description": "Analyze mock flight data for ES-Air, Logstash Airways, Kibana Airlines and JetBeats",
    "panelsJSON": "[ . . . ]",
    "optionsJSON": "{\"hidePanelTitles\":false,\"useMargins\":true}",
    "version": 1,
    "timeRestore": true,
    "timeTo": "now",
    "timeFrom": "now-24h",
    "refreshInterval": {
      "display": "15 minutes",
      "pause": false,
      "section": 2,
      "value": 900000
    },
    "kibanaSavedObjectMeta": {
      "searchSourceJSON": "{\"query\":{\"language\":\"kuery\",\"query\":\"\"},\"filter\":[],\"highlightAll\":true,\"version\":true}"
    }
  },
  "references": [
    {
      "name": "panel_0",
      "type": "visualization",
      "id": "aeb212e0-4c84-11e8-b3d7-01146121b73d"
    },
    . . .
    {
      "name": "panel_18",
      "type": "visualization",
      "id": "ed78a660-53a0-11e8-acbd-0be0ad9d822b"
    }
  ],
  "migrationVersion": {
    "dashboard": "7.0.0"
  }
}

« Saved objects APIs Bulk get objects API »