From 7b0a7531e3ca5a5620a9b9753041b1962eef07c6 Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Fri, 30 Apr 2021 18:37:47 +0100 Subject: [PATCH] Add note to Snapshot API doc to specify that user has to provide the entire dashboard model (#33572) (#33586) * Added note as suggested by Macus E. * Update docs/sources/http_api/snapshot.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> (cherry picked from commit 599a9b9a6df943a5ed63b773185f0767e9e07913) Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com> --- docs/sources/http_api/snapshot.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sources/http_api/snapshot.md b/docs/sources/http_api/snapshot.md index a602fa37bbb..5b88002f713 100644 --- a/docs/sources/http_api/snapshot.md +++ b/docs/sources/http_api/snapshot.md @@ -59,6 +59,8 @@ JSON Body schema: - **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`. +> **Note:** When creating a snapshot using the API, you have to provide the full dashboard payload including the snapshot data. This endpoint is designed for the Grafana UI. + **Example Response**: ```http