Snapshot API

    Example Request:

    JSON Body schema:

    • dashboard – Required. The complete dashboard model.
    • name – Optional. snapshot name
    • expires - Optional. When the snapshot should expire in seconds. 3600 is 1 hour, 86400 is 1 day. Default is never to expire.
    • external - Optional. Save the snapshot on an external server rather than locally. Default is false.
    • key - Optional. Define the unique key. Required if external is true.
    • deleteKey - Optional. Unique key used to delete the snapshot. It is different from the key so that only the creator can delete the snapshot. Required if external is true.

    Example Response:

    1.     HTTP/1.1 200
    2.     Content-Type: application/json
    3.     {
    4.       "deleteKey":"XXXXXXX",
    5.       "deleteUrl":"myurl/api/snapshots-delete/XXXXXXX",
    6.       "key":"YYYYYYY",
    7.       "url":"myurl/dashboard/snapshot/YYYYYYY",
    8.       "id": 1,
    9.     }

    Keys:

    • deleteKey – Key generated to delete the snapshot
    • key – Key generated to share the dashboard

    Query parameters:

    • query – Search Query
    • limit – Limit the number of returned results

    Example Request:

    1. GET /api/dashboard/snapshots HTTP/1.1
    2. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

    Example Response:

    GET /api/snapshots/:key

    Example Request:

    1. GET /api/snapshots/YYYYYYY HTTP/1.1
    2. Accept: application/json
    3. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {
    5.   "meta":{
    6.     "isSnapshot":true,
    7.     "type":"snapshot",
    8.     "canSave":false,
    9.     "canEdit":false,
    10.     "canStar":false,
    11.     "slug":"",
    12.     "expires":"2200-13-32T25:23:23+02:00",
    13.     "created":"2200-13-32T28:24:23+02:00"
    14.   },
    15.   "dashboard": {
    16.     "editable":false,
    17.     "hideControls":true,
    18.     "nav": [
    19.       {
    20.         "enable":false,
    21.         "type":"timepicker"
    22.     ],
    23.     "rows": [
    24.       {
    26.       }
    27.     ],
    28.     "style":"dark",
    29.     "tags":[],
    30.     "templating":{
    31.       "list":[
    32.       ]
    33.     },
    34.     "time":{
    35.     },
    36.     "timezone":"browser",
    37.     "title":"Home",
    38.     "version":5
    39.   }
    40. }

    DELETE /api/snapshots/:key

    Example Request:

    Example Response:

    1. HTTP/1.1 200
    2. Content-Type: application/json
    4. {"message":"Snapshot deleted. It might take an hour before it's cleared from any CDN caches.", "id": 1}

    This API call can be used without authentication by using the secret delete key for the snapshot.

    GET /api/snapshots-delete/:deleteKey

    1. GET /api/snapshots-delete/XXXXXXX HTTP/1.1

    Example Response: