Skip to content

Table of Contents

snapshot

Snapshot Objects

class Snapshot()

The class includes all necessary methods to access the Grafana snapshot API endpoints

Arguments:

  • grafana_api_model APIModel - Inject a Grafana API model object that includes all necessary values and information

Attributes:

  • grafana_api_model APIModel - This is where we store the grafana_api_model

create_new_snapshot

def create_new_snapshot(dashboard_json: dict,
                        name: str = None,
                        expires: int = None,
                        external: bool = False,
                        key: str = None,
                        delete_key: str = None) -> dict

The method includes a functionality to create the specified dashboard snapshot

Arguments:

  • dashboard_json dict - Specify the dashboard_json of the dashboard
  • name str - Specify the optional name of the dashboard snapshot
  • expires int - Specify the optional expiry time as seconds of the dashboard snapshot. 3600 is 1 hour, 86400 is 1 day (default never expired)
  • external bool - Specify the optional external server rather than locally (default False)
  • key str - Specify the optional unique key. Required if external is true.
  • delete_key str - Specify the 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.

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

  • api_call dict - Returns the snapshot information of the dashboard

get_snapshots

def get_snapshots() -> list

The method includes a functionality to list all dashboard snapshots

Raises:

  • Exception - Unspecified error by executing the API call

Returns:

  • api_call list - Returns all dashboard snapshots

get_snapshot_by_key

def get_snapshot_by_key(key: str) -> dict

The method includes a functionality to get a specific dashboard snapshot by the key

Arguments:

  • key str - Specify the key of the dashboard snapshot

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

  • api_call dict - Returns a specific dashboard snapshot

delete_snapshot_by_key

def delete_snapshot_by_key(key: str)

The method includes a functionality to delete a specific dashboard snapshot by the key

Arguments:

  • key str - Specify the key of the dashboard snapshot

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

None

delete_snapshot_by_delete_key

def delete_snapshot_by_delete_key(delete_key: str)

The method includes a functionality to delete a specific dashboard snapshot by the delete_key

Arguments:

  • delete_key str - Specify the delete_key of the dashboard snapshot

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

None