Get Snapshot by Key

GET 
/v1/grafana/api/snapshots/:key/

Gets Snapshot by Key. Please ensure to change the region in the URL to match your account's region.

Request

Path Parameters

key stringrequired

Responses

200

successful query

application/json

Schema

Schema

meta object
isSnapshot boolean
type string
canSave boolean
canEdit boolean
canStar boolean
slug string
expires string
created string
dashboard object

Dashboard.

editable boolean

Whether the dashboard is editable.

hideControls boolean

Whether to hide controls.

nav object[]

Nav.

Array [

enable boolean

Nav enabled or not.

type string

Nav type.

]

rows object[]

Rows.

style string

Style.

tags undefined[]

Tags.

templating object

Templating.

list undefined[]

List.

time object

Time.

timezone string

Time zone.

title string

Title.

version integer

Dashboard version.

Example (from schema)

{
  "meta": {
    "isSnapshot": true,
    "type": "snapshot",
    "canSave": true,
    "canEdit": true,
    "canStar": true,
    "slug": null,
    "expires": "2200-13-32T25:23:23+02:00",
    "created": "2200-13-32T28:24:23+02:00"
  },
  "dashboard": {
    "editable": true,
    "hideControls": true,
    "nav": [
      {
        "enable": true,
        "type": "timepicker"
      }
    ],
    "rows": [
      {}
    ],
    "style": "dark",
    "tags": [
      null
    ],
    "templating": {
      "list": [
        null
      ]
    },
    "time": {},
    "timezone": "browser",
    "title": "Home",
    "version": 5
  }
}

Loading...