opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-30 01:02:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add body options for snapshot api

Browse Source
This commit is contained in:
Daniel Lee
2017-06-13 23:17:14 +02:00
parent 1f92e589e8
commit cb720d8eaf
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/sources/http_api/snapshot.md
View File

@ -52,6 +52,15 @@ parent = "http_api"
"expires": 3600 "expires": 3600
} }
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**: **Example Response**:
HTTP/1.1 200 HTTP/1.1 200