← Tools Reference

Grafana

Grafana integration (Data, Developer Tools). Imported from open-connector.

API key14 tools{base_url}
GET
grafana_list_folders
List Grafana folders in a namespace with optional pagination.

/folders

3 parameters
ParamTypeRequiredDescription
namespacestringoptionalThe Grafana API namespace. Use default for the main organization.
limitintegeroptionalMaximum number of folders to request.
continueTokenstringoptionalThe Grafana continue token from a previous folder list response.
GET
grafana_get_folder
Retrieve one Grafana folder by UID.

/apis/{group}/namespaces/{namespace}/folders

3 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana folder UID.
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
groupstringrequiredPath parameter: group
POST
grafana_create_folder
Create a Grafana folder in a namespace.

/folders

5 parameters
ParamTypeRequiredDescription
titlestringrequiredThe new folder title.
uidstringoptionalOptional explicit Grafana folder UID.
generateNamestringoptionalOptional UID prefix Grafana can use to generate a folder UID.
parentUidstringoptionalOptional parent folder UID for a nested folder.
namespacestringoptionalThe Grafana API namespace. Use default for the main organization.
PUT
grafana_update_folder
Update the title or parent folder for a Grafana folder.

/apis/{group}/namespaces/{namespace}/folders

6 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana folder UID.
titlestringrequiredThe updated folder title.
parentUidstringoptionalOptional parent folder UID for a nested folder.
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
resourceVersionstringoptionalThe current Grafana resource version when required by the instance.
groupstringrequiredPath parameter: group
DELETE
grafana_delete_folder
Delete a Grafana folder by UID.

/apis/{group}/namespaces/{namespace}/folders

3 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana folder UID.
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
groupstringrequiredPath parameter: group
GET
grafana_search_dashboards
Search Grafana folders and dashboards by query, tags, type, folder, and pagination.

/api/search

8 parameters
ParamTypeRequiredDescription
querystringoptionalFree-text search query.
tagsarrayoptionalDashboard tags to search for.
typestringoptionalRestrict results to dashboards or folders.
dashboardUidsarrayoptionalDashboard UIDs to search for.
folderUidsarrayoptionalFolder UIDs to search in.
starredbooleanoptionalWhether to return only starred dashboards.
limitintegeroptionalMaximum number of search results to return.
pageintegeroptionalSearch results page number. Numbering starts at 1.
GET
grafana_get_dashboard
Retrieve one Grafana dashboard resource by UID.

/apis/{group}/namespaces/{namespace}/dashboards

3 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana dashboard UID.
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
groupstringrequiredPath parameter: group
PUT
grafana_update_dashboard
Replace a Grafana dashboard resource by UID.

/apis/{group}/namespaces/{namespace}/dashboards

6 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana dashboard UID.
folderUidstringoptionalOptional folder UID for the dashboard.
specobjectrequiredThe Grafana dashboard spec JSON. This is forwarded to Grafana as the dashboard …
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
resourceVersionstringoptionalThe current Grafana resource version when required by the instance.
groupstringrequiredPath parameter: group
DELETE
grafana_delete_dashboard
Delete a Grafana dashboard resource by UID.

/apis/{group}/namespaces/{namespace}/dashboards

3 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana dashboard UID.
namespacestringrequiredThe Grafana API namespace. Use default for the main organization.
groupstringrequiredPath parameter: group
GET
grafana_list_data_sources
List Grafana data sources available to the service account token.

/api/datasources

GET
grafana_get_data_source
Retrieve one Grafana data source by UID.

/api/datasources/uid/{uid}

1 parameter
ParamTypeRequiredDescription
uidstringrequiredThe Grafana data source UID.
POST
grafana_create_data_source
Create a Grafana data source using a JSON payload accepted by Grafana.

/api/datasources

1 parameter
ParamTypeRequiredDescription
dataSourceobjectoptionalThe Grafana data source payload. Use official Grafana data source fields such a…
PUT
grafana_update_data_source
Update a Grafana data source by UID using fields accepted by Grafana.

/api/datasources/uid/{uid}

2 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Grafana data source UID.
dataSourceobjectoptionalThe Grafana data source payload. Use official Grafana data source fields such a…
DELETE
grafana_delete_data_source
Delete a Grafana data source by UID.

/api/datasources/uid/{uid}

1 parameter
ParamTypeRequiredDescription
uidstringrequiredThe Grafana data source UID.