Grafana

Usage Instructions

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

Tools

`grafana_get_dashboard`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`dashboardUid`	string	Yes	No description

Output

Parameter	Type	Description
`dashboard`	json	The full dashboard JSON object
`meta`	json	Dashboard metadata (version, permissions, etc.)

`grafana_list_dashboards`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`query`	string	No	No description
`tag`	string	No	No description
`folderIds`	string	No	No description
`starred`	boolean	No	No description
`limit`	number	No	No description

Output

Parameter	Type	Description
`dashboards`	array	List of dashboard search results
↳ `id`	number	Dashboard ID
↳ `uid`	string	Dashboard UID
↳ `title`	string	Dashboard title
↳ `url`	string	Dashboard URL path
↳ `tags`	array	Dashboard tags
↳ `folderTitle`	string	Parent folder title

`grafana_create_dashboard`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`title`	string	Yes	No description
`folderUid`	string	No	No description
`tags`	string	No	No description
`timezone`	string	No	No description
`refresh`	string	No	No description
`panels`	string	No	No description
`overwrite`	boolean	No	No description
`message`	string	No	No description

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
`slug`	string	URL-friendly slug of the dashboard

`grafana_update_dashboard`

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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`dashboardUid`	string	Yes	No description
`title`	string	No	No description
`folderUid`	string	No	No description
`tags`	string	No	No description
`timezone`	string	No	No description
`refresh`	string	No	No description
`panels`	string	No	No description
`overwrite`	boolean	No	No description
`message`	string	No	No description

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
`slug`	string	URL-friendly slug of the dashboard

`grafana_delete_dashboard`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`dashboardUid`	string	Yes	No description

Output

Parameter	Type	Description
`title`	string	The title of the deleted dashboard
`message`	string	Confirmation message
`id`	number	The ID of the deleted dashboard

`grafana_list_alert_rules`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description

Output

Parameter	Type	Description
`rules`	array	List of alert rules
↳ `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
↳ `execErrState`	string	State on execution error

`grafana_get_alert_rule`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`alertRuleUid`	string	Yes	No description

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
`labels`	json	Alert labels

`grafana_create_alert_rule`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`title`	string	Yes	No description
`folderUid`	string	Yes	No description
`ruleGroup`	string	Yes	No description
`condition`	string	Yes	No description
`data`	string	Yes	No description
`forDuration`	string	No	No description
`noDataState`	string	No	No description
`execErrState`	string	No	No description
`annotations`	string	No	No description
`labels`	string	No	No description

Output

Parameter	Type	Description
`uid`	string	The UID of the created alert rule
`title`	string	Alert rule title
`folderUID`	string	Parent folder UID
`ruleGroup`	string	Rule group name

`grafana_update_alert_rule`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`alertRuleUid`	string	Yes	No description
`title`	string	No	No description
`folderUid`	string	No	No description
`ruleGroup`	string	No	No description
`condition`	string	No	No description
`data`	string	No	No description
`forDuration`	string	No	No description
`noDataState`	string	No	No description
`execErrState`	string	No	No description
`annotations`	string	No	No description
`labels`	string	No	No description

Output

Parameter	Type	Description
`uid`	string	The UID of the updated alert rule
`title`	string	Alert rule title
`folderUID`	string	Parent folder UID
`ruleGroup`	string	Rule group name

`grafana_delete_alert_rule`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`alertRuleUid`	string	Yes	No description

Output

Parameter	Type	Description
`message`	string	Confirmation message

`grafana_list_contact_points`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description

Output

Parameter	Type	Description
`contactPoints`	array	List of contact points
↳ `uid`	string	Contact point UID
↳ `name`	string	Contact point name
↳ `type`	string	Notification type (email, slack, etc.)
↳ `settings`	object	Type-specific settings

`grafana_create_annotation`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`text`	string	Yes	No description
`tags`	string	No	No description
`dashboardUid`	string	Yes	No description
`panelId`	number	No	No description
`time`	number	No	No description
`timeEnd`	number	No	No description

Output

Parameter	Type	Description
`id`	number	The ID of the created annotation
`message`	string	Confirmation message

`grafana_list_annotations`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`from`	number	No	No description
`to`	number	No	No description
`dashboardUid`	string	Yes	No description
`panelId`	number	No	No description
`tags`	string	No	No description
`type`	string	No	No description
`limit`	number	No	No description

Output

Parameter	Type	Description
`annotations`	array	List of annotations
↳ `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
↳ `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
↳ `data`	json	Additional annotation data object from Grafana

`grafana_update_annotation`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`annotationId`	number	Yes	No description
`text`	string	Yes	No description
`tags`	string	No	No description
`time`	number	No	No description
`timeEnd`	number	No	No description

Output

Parameter	Type	Description
`id`	number	The ID of the updated annotation
`message`	string	Confirmation message

`grafana_delete_annotation`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`annotationId`	number	Yes	No description

Output

Parameter	Type	Description
`message`	string	Confirmation message

`grafana_list_data_sources`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description

Output

Parameter	Type	Description
`dataSources`	array	List of data sources
↳ `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
↳ `isDefault`	boolean	Whether this is the default data source

`grafana_get_data_source`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`dataSourceId`	string	Yes	No description

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
`jsonData`	json	Additional data source configuration

`grafana_list_folders`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`limit`	number	No	No description
`page`	number	No	No description

Output

Parameter	Type	Description
`folders`	array	List of folders
↳ `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
↳ `version`	number	Version number of the folder

`grafana_create_folder`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`organizationId`	string	No	No description
`title`	string	Yes	No description
`uid`	string	No	No description

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
`version`	number	Version number of the folder

Grafana

On this page