List folders with the Grafana Cloud API
Lists 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.
- Identifier
- grafana_list_folders
The request
POST https://connect.reportei.com/api/tools/grafana_list_folders/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"namespace": "<namespace>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| namespace | string | Yes | stacks- followed by the instance ID shown under Details of the Grafana instance in the Grafana Cloud portal, for example stacks-123456. |
| limit | integer | No | Maximum number of folders to return. |
| continue | string | No | The metadata.continue token of the previous response, with the same limit. |
Supported connections
Your customer connects their Grafana Cloud account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
When connecting, your customer also enters {stack}: the address of their account on the app's API.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/grafana_list_folders. It becomes your agent's tool definition with no conversion.
Other Grafana Cloud tools
- 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.
- 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.
