Update dashboard with the Grafana Cloud API

Replaces 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.

Identifier
grafana_update_dashboard

The request

POST https://connect.reportei.com/api/tools/grafana_update_dashboard/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "namespace": "<namespace>",
    "name": "<name>",
    "metadata": {},
    "spec": {}
  }
}

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

ParameterTypeRequiredDescription
namespacestringYesstacks- followed by the instance ID shown under Details of the Grafana instance in the Grafana Cloud portal, for example stacks-123456.
namestringYesUid of the dashboard, the metadata.name from List dashboards.
metadataobjectYesIdentity, version and folder of the dashboard.
specobjectYesThe whole dashboard JSON model, as Get dashboard returned it, with the changes.

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_update_dashboard. It becomes your agent's tool definition with no conversion.

Other Grafana Cloud tools

See all 7 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.