Grafana Cloud tools
The 7 Grafana Cloud operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List dashboardsGETLists the dashboards of the stack. Each item has metadata.name, the uid the other tools ask for, the folder uid in the metadata annotation grafana.app/folder and the whole dashboard JSON in spec, with its title. Keep limit small; when metadata.continue comes back, pass it as continue for the next page.
- Get dashboardGETReturns one dashboard: metadata, with the uid in name, the resourceVersion and the folder annotation, and the dashboard JSON in spec, with title, panels, variables and time range.
- Create dashboardPOSTCreates a dashboard from its JSON in spec, at the root or in a folder. Send metadata.name with the uid you want, or metadata.generateName with a prefix for a random uid. A uid already in use answers 409.
- Update dashboardPUTReplaces a dashboard with a new version of its JSON. Read it with Get dashboard first, change spec and send back the whole spec, because fields left out are removed. Send the resourceVersion you read so a newer change is not overwritten; a stale one answers 409.
- List foldersGETLists the folders of the stack the token can see, each with metadata.name, the uid the folder fields of the other tools ask for, the parent folder in the metadata annotation grafana.app/folder and the title in spec. When metadata.continue comes back, pass it as continue for the next page.
- Create folderPOSTCreates a folder at the root or inside another folder. Send metadata.name with the uid you want, or metadata.generateName with a prefix for a random uid.
- Update folderPUTRenames a folder or moves it under another one. Send the title, and the parent in the annotation grafana.app/folder when it has one, because the call replaces the folder.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
