Grafana
Interact with Grafana dashboards, alerts, and annotations
Configuration
List Dashboards
Operation
List Dashboards
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Search Query
Filter dashboards by title
Filter by Tag
tag1, tag2 (comma-separated)
List Dashboards (
grafana_list_dashboards)Search and list all dashboards
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
query | string | No | Search query to filter dashboards by title |
tag | string | No | Filter by tag (comma-separated for multiple tags) |
folderIds | string | No | Filter by folder IDs (comma-separated) |
starred | boolean | No | Only return starred dashboards |
limit | number | No | Maximum number of dashboards to return |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | Dashboard ID |
uid | string | Dashboard UID |
title | string | Dashboard title |
url | string | Dashboard URL path |
tags | array | Dashboard tags |
Get Dashboard
Operation
Get Dashboard
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Dashboard UID*
Enter dashboard UID
Get Dashboard (
grafana_get_dashboard)Get a dashboard by its UID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
dashboardUid | string | Yes | The UID of the dashboard to retrieve |
Output
| Parameter | Type | Description |
|---|---|---|
dashboard | json | The full dashboard JSON object |
Create Dashboard
Operation
Create Dashboard
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Dashboard Title*
Enter dashboard title
Folder UID
Optional - folder to create dashboard in
Tags
tag1, tag2 (comma-separated)
Panels (JSON)
JSON array of panel configurations
Commit Message
Optional version message
Create Dashboard (
grafana_create_dashboard)Create a new dashboard
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
title | string | Yes | The title of the new dashboard |
folderUid | string | No | The UID of the folder to create the dashboard in |
tags | string | No | Comma-separated list of tags |
timezone | string | No | Dashboard timezone (e.g., browser, utc) |
refresh | string | No | Auto-refresh interval (e.g., 5s, 1m, 5m) |
panels | string | No | JSON array of panel configurations |
overwrite | boolean | No | Overwrite existing dashboard with same title |
message | string | No | Commit message for the dashboard version |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | The numeric ID of the created dashboard |
uid | string | The UID of the created dashboard |
url | string | The URL path to the dashboard |
status | string | Status of the operation (success) |
version | number | The version number of the dashboard |
Update Dashboard
Operation
Update Dashboard
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Dashboard UID*
Enter dashboard UID
Folder UID
Optional - folder to create dashboard in
Tags
tag1, tag2 (comma-separated)
Panels (JSON)
JSON array of panel configurations
Commit Message
Optional version message
Update Dashboard (
grafana_update_dashboard)Update an existing dashboard. Fetches the current dashboard and merges your changes.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
dashboardUid | string | Yes | The UID of the dashboard to update |
title | string | No | New title for the dashboard |
folderUid | string | No | New folder UID to move the dashboard to |
tags | string | No | Comma-separated list of new tags |
timezone | string | No | Dashboard timezone (e.g., browser, utc) |
refresh | string | No | Auto-refresh interval (e.g., 5s, 1m, 5m) |
panels | string | No | JSON array of panel configurations |
overwrite | boolean | No | Overwrite even if there is a version conflict |
message | string | No | Commit message for this version |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | The numeric ID of the updated dashboard |
uid | string | The UID of the updated dashboard |
url | string | The URL path to the dashboard |
status | string | Status of the operation (success) |
version | number | The new version number of the dashboard |
Delete Dashboard
Operation
Delete Dashboard
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Dashboard UID*
Enter dashboard UID
Delete Dashboard (
grafana_delete_dashboard)Delete a dashboard by its UID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
dashboardUid | string | Yes | The UID of the dashboard to delete |
Output
| Parameter | Type | Description |
|---|---|---|
title | string | The title of the deleted dashboard |
message | string | Confirmation message |
List Alert Rules
Operation
List Alert Rules
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
List Alert Rules (
grafana_list_alert_rules)List all alert rules in the Grafana instance
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
Output
| Parameter | Type | Description |
|---|---|---|
uid | string | Alert rule UID |
title | string | Alert rule title |
condition | string | Alert condition |
folderUID | string | Parent folder UID |
ruleGroup | string | Rule group name |
noDataState | string | State when no data is returned |
Get Alert Rule
Operation
Get Alert Rule
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Alert Rule UID*
Enter alert rule UID
Get Alert Rule (
grafana_get_alert_rule)Get a specific alert rule by its UID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
alertRuleUid | string | Yes | The UID of the alert rule to retrieve |
Output
| Parameter | Type | Description |
|---|---|---|
uid | string | Alert rule UID |
title | string | Alert rule title |
condition | string | Alert condition |
data | json | Alert rule query data |
folderUID | string | Parent folder UID |
ruleGroup | string | Rule group name |
noDataState | string | State when no data is returned |
execErrState | string | State on execution error |
annotations | json | Alert annotations |
Create Alert Rule
Operation
Create Alert Rule
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Folder UID
Optional - folder to create dashboard in
Alert Title
Enter alert rule name
Folder UID
Folder UID for the alert rule
Rule Group
Enter rule group name
Condition
Condition refId (e.g., A)
Query Data (JSON)
JSON array of query/expression data objects
For Duration
5m (e.g., 5m, 1h)
No Data State
Select...
Error State
Select...
Create Alert Rule (
grafana_create_alert_rule)Create a new alert rule
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
title | string | Yes | The title of the alert rule |
folderUid | string | Yes | The UID of the folder to create the alert in |
ruleGroup | string | Yes | The name of the rule group |
condition | string | Yes | The refId of the query or expression to use as the alert condition |
data | string | Yes | JSON array of query/expression data objects |
forDuration | string | No | Duration to wait before firing (e.g., 5m, 1h) |
noDataState | string | No | State when no data is returned (NoData, Alerting, OK) |
execErrState | string | No | State on execution error (Alerting, OK) |
annotations | string | No | JSON object of annotations |
labels | string | No | JSON object of labels |
Output
| Parameter | Type | Description |
|---|---|---|
uid | string | The UID of the created alert rule |
title | string | Alert rule title |
folderUID | string | Parent folder UID |
Update Alert Rule
Operation
Update Alert Rule
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Alert Rule UID*
Enter alert rule UID
Alert Title
Enter alert rule name
Folder UID
Folder UID for the alert rule
Rule Group
Enter rule group name
Condition
Condition refId (e.g., A)
Query Data (JSON)
JSON array of query/expression data objects
For Duration
5m (e.g., 5m, 1h)
No Data State
Select...
Error State
Select...
Update Alert Rule (
grafana_update_alert_rule)Update an existing alert rule. Fetches the current rule and merges your changes.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
alertRuleUid | string | Yes | The UID of the alert rule to update |
title | string | No | New title for the alert rule |
folderUid | string | No | New folder UID to move the alert to |
ruleGroup | string | No | New rule group name |
condition | string | No | New condition refId |
data | string | No | New JSON array of query/expression data objects |
forDuration | string | No | Duration to wait before firing (e.g., 5m, 1h) |
noDataState | string | No | State when no data is returned (NoData, Alerting, OK) |
execErrState | string | No | State on execution error (Alerting, OK) |
annotations | string | No | JSON object of annotations |
labels | string | No | JSON object of labels |
Output
| Parameter | Type | Description |
|---|---|---|
uid | string | The UID of the updated alert rule |
title | string | Alert rule title |
folderUID | string | Parent folder UID |
Delete Alert Rule
Operation
Delete Alert Rule
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Alert Rule UID*
Enter alert rule UID
Delete Alert Rule (
grafana_delete_alert_rule)Delete an alert rule by its UID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
alertRuleUid | string | Yes | The UID of the alert rule to delete |
Output
Refer to the block outputs for this operation.
List Contact Points
Operation
List Contact Points
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
List Contact Points (
grafana_list_contact_points)List all alert notification contact points
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
Output
| Parameter | Type | Description |
|---|---|---|
uid | string | Contact point UID |
name | string | Contact point name |
type | string | Notification type (email, slack, etc.) |
Create Annotation
Operation
Create Annotation
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Annotation Text*
Enter annotation text...
Tags
tag1, tag2 (comma-separated)
Dashboard UID*
Enter dashboard UID
Panel ID
Optional - attach to specific panel
Time (epoch ms)
Optional - defaults to now
End Time (epoch ms)
Optional - for range annotations
Create Annotation (
grafana_create_annotation)Create an annotation on a dashboard or as a global annotation
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
text | string | Yes | The text content of the annotation |
tags | string | No | Comma-separated list of tags |
dashboardUid | string | Yes | UID of the dashboard to add the annotation to |
panelId | number | No | ID of the panel to add the annotation to |
time | number | No | Start time in epoch milliseconds (defaults to now) |
timeEnd | number | No | End time in epoch milliseconds (for range annotations) |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | The ID of the created annotation |
List Annotations
Operation
List Annotations
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Tags
tag1, tag2 (comma-separated)
Dashboard UID*
Enter dashboard UID
Panel ID
Optional - attach to specific panel
From Time (epoch ms)
Filter from time
To Time (epoch ms)
Filter to time
List Annotations (
grafana_list_annotations)Query annotations by time range, dashboard, or tags
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
from | number | No | Start time in epoch milliseconds |
to | number | No | End time in epoch milliseconds |
dashboardUid | string | Yes | Dashboard UID to query annotations from |
panelId | number | No | Filter by panel ID |
tags | string | No | Comma-separated list of tags to filter by |
type | string | No | Filter by type (alert or annotation) |
limit | number | No | Maximum number of annotations to return |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | Annotation ID |
dashboardId | number | Dashboard ID |
dashboardUID | string | Dashboard UID |
created | number | Creation timestamp in epoch ms |
updated | number | Last update timestamp in epoch ms |
time | number | Start time in epoch ms |
timeEnd | number | End time in epoch ms |
text | string | Annotation text |
tags | array | Annotation tags |
items | string | items output |
login | string | Login of the user who created the annotation |
email | string | Email of the user who created the annotation |
avatarUrl | string | Avatar URL of the user |
Update Annotation
Operation
Update Annotation
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Annotation Text*
Enter annotation text...
Tags
tag1, tag2 (comma-separated)
Time (epoch ms)
Optional - defaults to now
End Time (epoch ms)
Optional - for range annotations
Annotation ID*
Enter annotation ID
Update Annotation (
grafana_update_annotation)Update an existing annotation
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
annotationId | number | Yes | The ID of the annotation to update |
text | string | Yes | New text content for the annotation |
tags | string | No | Comma-separated list of new tags |
time | number | No | New start time in epoch milliseconds |
timeEnd | number | No | New end time in epoch milliseconds |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | The ID of the updated annotation |
Delete Annotation
Operation
Delete Annotation
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Annotation ID*
Enter annotation ID
Delete Annotation (
grafana_delete_annotation)Delete an annotation by its ID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
annotationId | number | Yes | The ID of the annotation to delete |
Output
Refer to the block outputs for this operation.
List Data Sources
Operation
List Data Sources
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
List Data Sources (
grafana_list_data_sources)List all data sources configured in Grafana
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | Data source ID |
uid | string | Data source UID |
name | string | Data source name |
type | string | Data source type (prometheus, mysql, etc.) |
url | string | Data source URL |
Get Data Source
Operation
Get Data Source
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Data Source ID*
Enter data source ID or UID
Get Data Source (
grafana_get_data_source)Get a data source by its ID or UID
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
dataSourceId | string | Yes | The ID or UID of the data source to retrieve |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | Data source ID |
uid | string | Data source UID |
name | string | Data source name |
type | string | Data source type |
url | string | Data source connection URL |
database | string | Database name (if applicable) |
isDefault | boolean | Whether this is the default data source |
List Folders
Operation
List Folders
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
List Folders (
grafana_list_folders)List all folders in Grafana
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
limit | number | No | Maximum number of folders to return |
page | number | No | Page number for pagination |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | Folder ID |
uid | string | Folder UID |
title | string | Folder title |
hasAcl | boolean | Whether the folder has custom ACL permissions |
canSave | boolean | Whether the current user can save the folder |
canEdit | boolean | Whether the current user can edit the folder |
canAdmin | boolean | Whether the current user has admin rights |
canDelete | boolean | Whether the current user can delete the folder |
createdBy | string | Username of who created the folder |
created | string | Timestamp when the folder was created |
updatedBy | string | Username of who last updated the folder |
updated | string | Timestamp when the folder was last updated |
Create Folder
Operation
Create Folder
Grafana URL*
https://your-grafana.com
Service Account Token*
••••••••
Organization ID
Optional - for multi-org instances
Folder Title*
Enter folder title
Folder UID
Optional - auto-generated if not provided
Create Folder (
grafana_create_folder)Create a new folder in Grafana
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Grafana Service Account Token |
baseUrl | string | Yes | Grafana instance URL (e.g., https://your-grafana.com\) |
organizationId | string | No | Organization ID for multi-org Grafana instances |
title | string | Yes | The title of the new folder |
uid | string | No | Optional UID for the folder (auto-generated if not provided) |
Output
| Parameter | Type | Description |
|---|---|---|
id | number | The numeric ID of the created folder |
uid | string | The UID of the created folder |
title | string | The title of the created folder |
url | string | The URL path to the folder |
hasAcl | boolean | Whether the folder has custom ACL permissions |
canSave | boolean | Whether the current user can save the folder |
canEdit | boolean | Whether the current user can edit the folder |
canAdmin | boolean | Whether the current user has admin rights on the folder |
canDelete | boolean | Whether the current user can delete the folder |
createdBy | string | Username of who created the folder |
created | string | Timestamp when the folder was created |
updatedBy | string | Username of who last updated the folder |
updated | string | Timestamp when the folder was last updated |
Usage Instructions
Integrate Grafana into workflows. Manage dashboards, alerts, annotations, data sources, folders, and monitor health status.
Notes
- Category:
tools - Type:
grafana