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
- Create/Update (
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>) |
|---|---|
dashboard | dashboard.createUpdate, dashboard.get, dashboard.list |
Properties
Common
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Resource | resource | options | Yes | dashboard | Dashboard (dashboard) | - |
| Operation | operation | options | Yes | createUpdate | Create/Update (createUpdate), Get (get), List (list) | resource = dashboard |
Dashboard → Create/Update
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Dashboard JSON | dashboard | json | Yes | {} | 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 UID | folderUid | string | No | '' | UID of the folder to save the dashboard into. Leave empty for the General folder. | resource = dashboard, operation = createUpdate |
| Overwrite | overwrite | boolean | No | false | Bypass 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 Message | message | string | No | '' | Optional message describing the changes made to this dashboard version | resource = dashboard, operation = createUpdate |
Dashboard → Get
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Dashboard UID | uid | string | Yes | '' | UID of the dashboard to fetch | resource = dashboard, operation = get |
Dashboard → List
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Query | query | string | No | '' | Search string to filter dashboards by title | resource = dashboard, operation = list |
| Folder UIDs | folderUids | string | No | '' | Comma-separated folder UIDs to limit the search to | resource = dashboard, operation = list |
| Limit | limit | number | No | 100 | Maximum number of dashboards to return | resource = 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 }.