GRgrafana
dashboards
snapshots

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.

Snapshot public mode should be enabled or authentication is required.

post/snapshots

Request

  • Base URL
    /api (relative, and the document’s source URL is not known)
  • URL
    /api/snapshots
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional

deleteKeystring

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.

expiresinteger

When the snapshot should expire in seconds in seconds. Default is never to expire.

externalboolean

these are passed when storing an external snapshot ref Save the snapshot on an external server rather than locally.

keystring

Define the unique key. Required if external is true.

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional

namestring

Snapshot name

Response

(empty)

deleteKeystring

Unique key used to delete the snapshot. It is different from the key so that only the creator can delete the snapshot.

deleteUrlstring
idinteger

Snapshot id

keystring

Unique key

urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.