Skip to main content

Grafana Dashboard

Type ID: grafanaDashboard  ·  Kind: Action  ·  Ports: 1 in, 1 out

Create, update, fetch, and list Grafana dashboards.

Credentials​

Grafana (Service Account Token)

{
"credentials": {
"name": "grafana",
"id": "<credential-id>"
}
}

Resources & operations​

  • Dashboard (dashboard)
    • Create/Update (createUpdate) - Create a new dashboard or save a new version of an existing one
    • Get (get) - Fetch a dashboard by UID
    • List (list) - Search/list dashboards

For agent integrations (name: 'grafanaDashboard' in permissions.integrations), grant '*', a resource key, or an operation key — see Tools and Permissions:

Resource key (<resource>)Operation keys (<resource>.<operation>)
dashboarddashboard.createUpdate, dashboard.get, dashboard.list

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsYesdashboardDashboard (dashboard)-
OperationoperationoptionsYescreateUpdateCreate/Update (createUpdate), Get (get), List (list)resource = dashboard

Dashboard → Create/Update​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Dashboard JSONdashboardjsonYes{}Full dashboard JSON model. To update an existing dashboard, include its "uid" and "id"/"version" fields as returned by Get Dashboard.resource = dashboard, operation = createUpdate
Folder UIDfolderUidstringNo''UID of the folder to save the dashboard into. Leave empty for the General folder.resource = dashboard, operation = createUpdate
OverwriteoverwritebooleanNofalseBypass optimistic concurrency and force-save even if the dashboard was changed by someone else since it was last fetched. This silently clobbers those concurrent edits — leave off to fail with a version-conflict error instead.resource = dashboard, operation = createUpdate
Commit MessagemessagestringNo''Optional message describing the changes made to this dashboard versionresource = dashboard, operation = createUpdate

Dashboard → Get​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Dashboard UIDuidstringYes''UID of the dashboard to fetchresource = dashboard, operation = get

Dashboard → List​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
QueryquerystringNo''Search string to filter dashboards by titleresource = dashboard, operation = list
Folder UIDsfolderUidsstringNo''Comma-separated folder UIDs to limit the search toresource = dashboard, operation = list
LimitlimitnumberNo100Maximum number of dashboards to returnresource = dashboard, operation = list

Notes​

  • Create/Update output: { id, uid, url, version, status, raw }.
  • Get output: { uid, title, version, dashboard, meta, raw }.
  • List output: { dashboards, count }.