Sim

Grafana

Interact with Grafana dashboards, alerts, and annotations

Grafana is a leading open-source platform for monitoring, observability, and visualization. It allows users to query, visualize, alert on, and analyze data from a variety of sources, making it an essential tool for infrastructure and application monitoring.

With Grafana, you can:

  • Visualize data: Build and customize dashboards to display metrics, logs, and traces in real time
  • Monitor health and status: Check the health of your Grafana instance and connected data sources
  • Manage alerts and annotations: Set up alert rules, manage notifications, and annotate dashboards with important events
  • Organize content: Organize dashboards and data sources into folders for better access management

In Sim, the Grafana integration empowers your agents to interact directly with your Grafana instance via API, enabling actions such as:

  • Checking the Grafana server, database, and data source health status
  • Retrieving, listing, and managing dashboards, alert rules, annotations, data sources, and folders
  • Automating the monitoring of your infrastructure by integrating Grafana data and alerts into your workflow automations

These capabilities enable Sim agents to monitor systems, proactively respond to alerts, and help ensure the reliability and visibility of your services — all as part of your automated workflows.

Usage Instructions

Integrate Grafana into workflows. Manage dashboards, alerts, annotations, data sources, folders, and monitor health status.

Tools

grafana_get_dashboard

Get a dashboard by its UID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
dashboardUidstringYesThe UID of the dashboard to retrieve

Output

ParameterTypeDescription
dashboardjsonThe full dashboard JSON object
metajsonDashboard metadata (version, permissions, etc.)

grafana_list_dashboards

Search and list all dashboards

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
querystringNoSearch query to filter dashboards by title
tagstringNoFilter by tag (comma-separated for multiple tags)
folderIdsstringNoFilter by folder IDs (comma-separated)
starredbooleanNoOnly return starred dashboards
limitnumberNoMaximum number of dashboards to return

Output

ParameterTypeDescription
dashboardsarrayList of dashboard search results

grafana_create_dashboard

Create a new dashboard

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
titlestringYesThe title of the new dashboard
folderUidstringNoThe UID of the folder to create the dashboard in
tagsstringNoComma-separated list of tags
timezonestringNoDashboard timezone (e.g., browser, utc)
refreshstringNoAuto-refresh interval (e.g., 5s, 1m, 5m)
panelsstringNoJSON array of panel configurations
overwritebooleanNoOverwrite existing dashboard with same title
messagestringNoCommit message for the dashboard version

Output

ParameterTypeDescription
idnumberThe numeric ID of the created dashboard
uidstringThe UID of the created dashboard
urlstringThe URL path to the dashboard
statusstringStatus of the operation (success)
versionnumberThe version number of the dashboard
slugstringURL-friendly slug of the dashboard

grafana_update_dashboard

Update an existing dashboard. Fetches the current dashboard and merges your changes.

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
dashboardUidstringYesThe UID of the dashboard to update
titlestringNoNew title for the dashboard
folderUidstringNoNew folder UID to move the dashboard to
tagsstringNoComma-separated list of new tags
timezonestringNoDashboard timezone (e.g., browser, utc)
refreshstringNoAuto-refresh interval (e.g., 5s, 1m, 5m)
panelsstringNoJSON array of panel configurations
overwritebooleanNoOverwrite even if there is a version conflict
messagestringNoCommit message for this version

Output

ParameterTypeDescription
idnumberThe numeric ID of the updated dashboard
uidstringThe UID of the updated dashboard
urlstringThe URL path to the dashboard
statusstringStatus of the operation (success)
versionnumberThe new version number of the dashboard
slugstringURL-friendly slug of the dashboard

grafana_delete_dashboard

Delete a dashboard by its UID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
dashboardUidstringYesThe UID of the dashboard to delete

Output

ParameterTypeDescription
titlestringThe title of the deleted dashboard
messagestringConfirmation message
idnumberThe ID of the deleted dashboard

grafana_list_alert_rules

List all alert rules in the Grafana instance

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances

Output

ParameterTypeDescription
rulesarrayList of alert rules

grafana_get_alert_rule

Get a specific alert rule by its UID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
alertRuleUidstringYesThe UID of the alert rule to retrieve

Output

ParameterTypeDescription
uidstringAlert rule UID
titlestringAlert rule title
conditionstringAlert condition
datajsonAlert rule query data
folderUIDstringParent folder UID
ruleGroupstringRule group name
noDataStatestringState when no data is returned
execErrStatestringState on execution error
annotationsjsonAlert annotations
labelsjsonAlert labels

grafana_create_alert_rule

Create a new alert rule

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
titlestringYesThe title of the alert rule
folderUidstringYesThe UID of the folder to create the alert in
ruleGroupstringYesThe name of the rule group
conditionstringYesThe refId of the query or expression to use as the alert condition
datastringYesJSON array of query/expression data objects
forDurationstringNoDuration to wait before firing (e.g., 5m, 1h)
noDataStatestringNoState when no data is returned (NoData, Alerting, OK)
execErrStatestringNoState on execution error (Alerting, OK)
annotationsstringNoJSON object of annotations
labelsstringNoJSON object of labels

Output

ParameterTypeDescription
uidstringThe UID of the created alert rule
titlestringAlert rule title
folderUIDstringParent folder UID
ruleGroupstringRule group name

grafana_update_alert_rule

Update an existing alert rule. Fetches the current rule and merges your changes.

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
alertRuleUidstringYesThe UID of the alert rule to update
titlestringNoNew title for the alert rule
folderUidstringNoNew folder UID to move the alert to
ruleGroupstringNoNew rule group name
conditionstringNoNew condition refId
datastringNoNew JSON array of query/expression data objects
forDurationstringNoDuration to wait before firing (e.g., 5m, 1h)
noDataStatestringNoState when no data is returned (NoData, Alerting, OK)
execErrStatestringNoState on execution error (Alerting, OK)
annotationsstringNoJSON object of annotations
labelsstringNoJSON object of labels

Output

ParameterTypeDescription
uidstringThe UID of the updated alert rule
titlestringAlert rule title
folderUIDstringParent folder UID
ruleGroupstringRule group name

grafana_delete_alert_rule

Delete an alert rule by its UID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
alertRuleUidstringYesThe UID of the alert rule to delete

Output

ParameterTypeDescription
messagestringConfirmation message

grafana_list_contact_points

List all alert notification contact points

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances

Output

ParameterTypeDescription
contactPointsarrayList of contact points

grafana_create_annotation

Create an annotation on a dashboard or as a global annotation

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
textstringYesThe text content of the annotation
tagsstringNoComma-separated list of tags
dashboardUidstringNoUID of the dashboard to add the annotation to (optional for global annotations)
panelIdnumberNoID of the panel to add the annotation to
timenumberNoStart time in epoch milliseconds (defaults to now)
timeEndnumberNoEnd time in epoch milliseconds (for range annotations)

Output

ParameterTypeDescription
idnumberThe ID of the created annotation
messagestringConfirmation message

grafana_list_annotations

Query annotations by time range, dashboard, or tags

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
fromnumberNoStart time in epoch milliseconds
tonumberNoEnd time in epoch milliseconds
dashboardUidstringNoFilter by dashboard UID
panelIdnumberNoFilter by panel ID
tagsstringNoComma-separated list of tags to filter by
typestringNoFilter by type (alert or annotation)
limitnumberNoMaximum number of annotations to return

Output

ParameterTypeDescription
annotationsarrayList of annotations

grafana_update_annotation

Update an existing annotation

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
annotationIdnumberYesThe ID of the annotation to update
textstringYesNew text content for the annotation
tagsstringNoComma-separated list of new tags
timenumberNoNew start time in epoch milliseconds
timeEndnumberNoNew end time in epoch milliseconds

Output

ParameterTypeDescription
idnumberThe ID of the updated annotation
messagestringConfirmation message

grafana_delete_annotation

Delete an annotation by its ID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
annotationIdnumberYesThe ID of the annotation to delete

Output

ParameterTypeDescription
messagestringConfirmation message

grafana_list_data_sources

List all data sources configured in Grafana

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances

Output

ParameterTypeDescription
dataSourcesarrayList of data sources

grafana_get_data_source

Get a data source by its ID or UID

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
dataSourceIdstringYesThe ID or UID of the data source to retrieve

Output

ParameterTypeDescription
idnumberData source ID
uidstringData source UID
namestringData source name
typestringData source type
urlstringData source connection URL
databasestringDatabase name (if applicable)
isDefaultbooleanWhether this is the default data source
jsonDatajsonAdditional data source configuration

grafana_list_folders

List all folders in Grafana

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
limitnumberNoMaximum number of folders to return
pagenumberNoPage number for pagination

Output

ParameterTypeDescription
foldersarrayList of folders

grafana_create_folder

Create a new folder in Grafana

Input

ParameterTypeRequiredDescription
apiKeystringYesGrafana Service Account Token
baseUrlstringYesGrafana instance URL (e.g., https://your-grafana.com\)
organizationIdstringNoOrganization ID for multi-org Grafana instances
titlestringYesThe title of the new folder
uidstringNoOptional UID for the folder (auto-generated if not provided)

Output

ParameterTypeDescription
idnumberThe numeric ID of the created folder
uidstringThe UID of the created folder
titlestringThe title of the created folder
urlstringThe URL path to the folder

Notes

  • Category: tools
  • Type: grafana
On this page

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started