Skip to main content
Server path: /grafana-dashboards | Type: Application | PCID required: Yes

Tools

ToolDescription
grafana_dashboards_create_dashboard_snapshotWhen 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.
grafana_dashboards_create_library_elementCreate library element.
grafana_dashboards_create_public_dashboardCreate public dashboard for a dashboard
grafana_dashboards_delete_dashboard_snapshotDelete Snapshot by Key.
grafana_dashboards_delete_dashboard_snapshot_by_delete_keyDelete Snapshot by deleteKey.
grafana_dashboards_delete_library_element_by_uidDelete library element.
grafana_dashboards_delete_public_dashboardDelete public dashboard for a dashboard
grafana_dashboards_get_dashboard_snapshotGet Snapshot by Key.
grafana_dashboards_get_library_element_by_nameGet library element by name.
grafana_dashboards_get_library_element_by_uidGet library element by UID.
grafana_dashboards_get_library_element_connectionsGet library element connections.
grafana_dashboards_get_library_elementsGet all library elements.
grafana_dashboards_get_public_annotationsGet annotations for a public dashboard
grafana_dashboards_get_public_dashboardGet public dashboard by dashboardUid
grafana_dashboards_import_dashboardImport dashboard.
grafana_dashboards_interpolate_dashboardInterpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.
grafana_dashboards_list_public_dashboardsGet list of public dashboards
grafana_dashboards_list_sort_optionsList search sorting options.
grafana_dashboards_query_public_dashboardGet results for a given panel on a public dashboard
grafana_dashboards_searchGET /search
grafana_dashboards_search_dashboard_snapshotsList snapshots.
grafana_dashboards_update_folder_permissionsUpdates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.
grafana_dashboards_update_library_elementUpdate library element.
grafana_dashboards_update_public_dashboardUpdate public dashboard for a dashboard
grafana_dashboards_view_public_dashboardGet public dashboard for view

grafana_dashboards_create_dashboard_snapshot

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. Parameters:
ParameterTypeRequiredDefaultDescription
apiVersionstringNoAPIVersion 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
dashboardobjectYesUnstructured allows objects that do not have Golang structs registered to be manipulated generically.
deleteKeystringNoUnique 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.
expiresintegerNoWhen the snapshot should expire in seconds in seconds. Default is never to expire.
externalbooleanNothese are passed when storing an external snapshot ref Save the snapshot on an external server rather than locally.
keystringNoDefine the unique key. Required if external is true.
kindstringNoKind 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
namestringNoSnapshot name

grafana_dashboards_create_library_element

Create library element. Parameters:
ParameterTypeRequiredDefaultDescription
folderIdintegerNoID of the folder where the library element is stored. Deprecated: use FolderUID instead
folderUidstringNoUID of the folder where the library element is stored.
kindintegerNoKind of element to create, Use 1 for library panels or 2 for c. Description: 1 - library panels
modelobjectNoThe JSON model for the library element.
namestringNoName of the library element.
uidstringNoThe uid value

grafana_dashboards_create_public_dashboard

Create public dashboard for a dashboard Parameters:
ParameterTypeRequiredDefaultDescription
dashboardUidstringYesDashboard Uid
accessTokenstringNoAccess Token
annotationsEnabledbooleanNoAnnotations Enabled
isEnabledbooleanNoIs Enabled
sharestringNoThe share value
timeSelectionEnabledbooleanNoTime Selection Enabled
uidstringNoThe uid value

grafana_dashboards_delete_dashboard_snapshot

Delete Snapshot by Key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value

grafana_dashboards_delete_dashboard_snapshot_by_delete_key

Delete Snapshot by deleteKey. Parameters:
ParameterTypeRequiredDefaultDescription
deleteKeystringYesDelete Key

grafana_dashboards_delete_library_element_by_uid

Delete library element. Parameters:
ParameterTypeRequiredDefaultDescription
library_element_uidstringYesLibrary Element Uid

grafana_dashboards_delete_public_dashboard

Delete public dashboard for a dashboard Parameters:
ParameterTypeRequiredDefaultDescription
dashboardUidstringYesDashboard Uid
uidstringYesThe uid value

grafana_dashboards_get_dashboard_snapshot

Get Snapshot by Key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value

grafana_dashboards_get_library_element_by_name

Get library element by name. Parameters:
ParameterTypeRequiredDefaultDescription
library_element_namestringYesLibrary Element Name

grafana_dashboards_get_library_element_by_uid

Get library element by UID. Parameters:
ParameterTypeRequiredDefaultDescription
library_element_uidstringYesLibrary Element Uid

grafana_dashboards_get_library_element_connections

Get library element connections. Parameters:
ParameterTypeRequiredDefaultDescription
library_element_uidstringYesLibrary Element Uid

grafana_dashboards_get_library_elements

Get all library elements. Parameters:
ParameterTypeRequiredDefaultDescription
searchStringstringNoPart of the name or description searched for.
kindintegerNoKind of element to search for.
sortDirectionstringNoSort order of elements.
typeFilterstringNoA comma separated list of types to filter the elements by
excludeUidstringNoElement UID to exclude from search results.
folderFilterstringNoA comma separated list of folder ID(s) to filter the elements by. Deprecated: Use FolderFilterUIDs instead.
folderFilterUIDsstringNoA comma separated list of folder UID(s) to filter the elements by.
perPageintegerNoThe number of results per page.
pageintegerNoThe page for a set of records, given that only perPage records are returned at a time. Numbering starts at 1.

grafana_dashboards_get_public_annotations

Get annotations for a public dashboard Parameters:
ParameterTypeRequiredDefaultDescription
accessTokenstringYesAccess Token

grafana_dashboards_get_public_dashboard

Get public dashboard by dashboardUid Parameters:
ParameterTypeRequiredDefaultDescription
dashboardUidstringYesDashboard Uid

grafana_dashboards_import_dashboard

Import dashboard. Parameters:
ParameterTypeRequiredDefaultDescription
dashboardobjectNoThe dashboard value
folderIdintegerNoDeprecated: use FolderUID instead
folderUidstringNoFolder Uid
inputsobject[]NoThe inputs value
overwritebooleanNoThe overwrite value
pathstringNoThe path value
pluginIdstringNoPlugin Id

grafana_dashboards_interpolate_dashboard

Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.

grafana_dashboards_list_public_dashboards

Get list of public dashboards

grafana_dashboards_list_sort_options

List search sorting options.

grafana_dashboards_query_public_dashboard

Get results for a given panel on a public dashboard Parameters:
ParameterTypeRequiredDefaultDescription
accessTokenstringYesAccess Token
panelIdintegerYesPanel Id

GET /search Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch Query
tagstring[]NoList of tags to search for
typestringNoType to search for, dash-folder or dash-db
dashboardIdsinteger[]NoList of dashboard id’s to search for This is deprecated: users should use the dashboardUIDs query parameter instead
dashboardUIDsstring[]NoList of dashboard uid’s to search for
folderIdsinteger[]NoList of folder id’s to search in for dashboards If it’s 0 then it will query for the top level folders This is deprecated: users should use the folderUIDs query parameter instead
folderUIDsstring[]NoList of folder UID’s to search in for dashboards If it’s an empty string then it will query for the top level folders
starredbooleanNoFlag indicating if only starred Dashboards should be returned
limitintegerNoLimit the number of returned results (max 5000)
pageintegerNoUse this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
permissionstringNoSet to Edit to return dashboards/folders that the user can edit
sortstringNoSort method; for listing all the possible sort methods use the search sorting endpoint.
deletedbooleanNoFlag indicating if only soft deleted Dashboards should be returned

grafana_dashboards_search_dashboard_snapshots

List snapshots. Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch Query
limitintegerNoLimit the number of returned results

grafana_dashboards_update_folder_permissions

Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request. Parameters:
ParameterTypeRequiredDefaultDescription
folder_uidstringYesFolder Uid
itemsobject[]NoThe items value

grafana_dashboards_update_library_element

Update library element. Parameters:
ParameterTypeRequiredDefaultDescription
library_element_uidstringYesLibrary Element Uid
folderIdintegerNoID of the folder where the library element is stored. Deprecated: use FolderUID instead
folderUidstringNoUID of the folder where the library element is stored.
kindintegerNoKind of element to create, Use 1 for library panels or 2 for c. Description: 1 - library panels
modelobjectNoThe JSON model for the library element.
namestringNoName of the library element.
uidstringNoThe uid value
versionintegerNoVersion of the library element you are updating.

grafana_dashboards_update_public_dashboard

Update public dashboard for a dashboard Parameters:
ParameterTypeRequiredDefaultDescription
dashboardUidstringYesDashboard Uid
uidstringYesThe uid value
accessTokenstringNoAccess Token
annotationsEnabledbooleanNoAnnotations Enabled
isEnabledbooleanNoIs Enabled
sharestringNoThe share value
timeSelectionEnabledbooleanNoTime Selection Enabled

grafana_dashboards_view_public_dashboard

Get public dashboard for view Parameters:
ParameterTypeRequiredDefaultDescription
accessTokenstringYesAccess Token