> ## Documentation Index > Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt > Use this file to discover all available pages before exploring further. # Grafana Integration for AI Agents & Workflows > Manage Grafana dashboards, alert rules, annotations, contact points, data sources, and folders, and monitor instance and data source health via the Grafana HTTP API. {/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */} Grafana logo ## Overview Add **Grafana** to any ModuleX agent or workflow. Manage Grafana dashboards, alert rules, annotations, contact points, data sources, and folders, and monitor instance and data source health against the Grafana HTTP API of your own instance. **Categories**: Monitoring & Observability · Monitoring · Data Analytics · **Auth**: Service Account Token · **Actions**: 25 ## Authentication ### Service Account Token Authenticate with a Grafana service account token against your instance In Grafana, open Administration -> Users and access -> Service accounts Create a service account with the roles your workflow needs (e.g. Editor or Admin) Add a service account token and copy the generated 'glsa\_...' value Paste the token below and set your Grafana instance URL (e.g. [https://your-grafana.com](https://your-grafana.com)) #### Required Credentials | Field | Description | Required | Format | | --------------------- | ----------------------------------------------------------------------------------------- | -------- | ------------------------------------------------ | | Service Account Token | Your Grafana service account token (starts with glsa\_) | Yes | `glsa_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxxxx` | | Grafana URL | Your Grafana instance base URL, e.g. [https://your-grafana.com](https://your-grafana.com) | Yes | `https://your-grafana.com` | ## Available Actions ### Parameters Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. Search query to filter dashboards by title Filter by tag (comma-separated for multiple tags) Filter by folder UIDs (comma-separated) Filter by dashboard UIDs (comma-separated) Only return starred dashboards Maximum number of dashboards to return Page number for pagination (1-based) ### Response ```json theme={null} { "$defs": { "DashboardSearchResult": { "additionalProperties": false, "description": "A single dashboard search-result row from ``/api/search``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uri" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "is_starred": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Starred" }, "folder_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Folder Id" }, "folder_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Uid" }, "folder_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Title" }, "folder_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Url" } }, "title": "DashboardSearchResult", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "dashboards": { "items": { "$ref": "#/$defs/DashboardSearchResult" }, "title": "Dashboards", "type": "array" } }, "required": [ "success" ], "title": "ListDashboardsOutput", "type": "object" } ``` ### Parameters The UID of the dashboard to retrieve Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "dashboard": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Dashboard" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Meta" } }, "required": [ "success" ], "title": "GetDashboardOutput", "type": "object" } ``` ### Parameters The title of the new dashboard UID of the folder to create the dashboard in Comma-separated list of tags Dashboard timezone (e.g. browser, utc) Auto-refresh interval (e.g. 5s, 1m, 5m) JSON array of panel configurations Overwrite an existing dashboard with the same title Commit message for the dashboard version Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Slug" } }, "required": [ "success" ], "title": "CreateDashboardOutput", "type": "object" } ``` ### Parameters The UID of the dashboard to update New title for the dashboard New folder UID to move the dashboard to Comma-separated list of new tags Dashboard timezone (e.g. browser, utc) Auto-refresh interval (e.g. 5s, 1m, 5m) JSON array of panel configurations Overwrite even on a version conflict Commit message for this version Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Slug" } }, "required": [ "success" ], "title": "UpdateDashboardOutput", "type": "object" } ``` ### Parameters The UID of the dashboard to delete Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" } }, "required": [ "success" ], "title": "DeleteDashboardOutput", "type": "object" } ``` ### Parameters Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "AlertRule": { "additionalProperties": false, "description": "A provisioned alert rule (shared by list/get/create/update).", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "data": { "items": {}, "title": "Data", "type": "array" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "no_data_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "No Data State" }, "exec_err_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exec Err State" }, "for_": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "For" }, "keep_firing_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keep Firing For" }, "missing_series_evals_to_resolve": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Missing Series Evals To Resolve" }, "annotations": { "additionalProperties": true, "title": "Annotations", "type": "object" }, "labels": { "additionalProperties": true, "title": "Labels", "type": "object" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Paused" }, "folder_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Uid" }, "rule_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rule Group" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" }, "notification_settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Notification Settings" }, "record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Record" } }, "title": "AlertRule", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "rules": { "items": { "$ref": "#/$defs/AlertRule" }, "title": "Rules", "type": "array" } }, "required": [ "success" ], "title": "ListAlertRulesOutput", "type": "object" } ``` ### Parameters The UID of the alert rule to retrieve Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "AlertRule": { "additionalProperties": false, "description": "A provisioned alert rule (shared by list/get/create/update).", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "data": { "items": {}, "title": "Data", "type": "array" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "no_data_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "No Data State" }, "exec_err_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exec Err State" }, "for_": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "For" }, "keep_firing_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keep Firing For" }, "missing_series_evals_to_resolve": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Missing Series Evals To Resolve" }, "annotations": { "additionalProperties": true, "title": "Annotations", "type": "object" }, "labels": { "additionalProperties": true, "title": "Labels", "type": "object" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Paused" }, "folder_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Uid" }, "rule_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rule Group" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" }, "notification_settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Notification Settings" }, "record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Record" } }, "title": "AlertRule", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "rule": { "anyOf": [ { "$ref": "#/$defs/AlertRule" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "GetAlertRuleOutput", "type": "object" } ``` ### Parameters The title of the alert rule UID of the folder to create the alert in The name of the rule group JSON array of query/expression data objects RefId of the query/expression used as the alert condition (omit for recording rules) Duration to wait before firing (e.g. 5m, 1h) State when no data is returned (NoData, Alerting, OK) State on execution error (Error, Alerting, OK) JSON object of annotations JSON object of labels Optional custom UID for the alert rule Whether the rule is paused on creation Duration to keep firing after the condition stops Missing series evaluations before resolving JSON object of per-rule notification settings JSON object configuring this as a recording rule Set the X-Disable-Provenance header so the rule stays UI-editable Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "AlertRule": { "additionalProperties": false, "description": "A provisioned alert rule (shared by list/get/create/update).", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "data": { "items": {}, "title": "Data", "type": "array" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "no_data_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "No Data State" }, "exec_err_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exec Err State" }, "for_": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "For" }, "keep_firing_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keep Firing For" }, "missing_series_evals_to_resolve": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Missing Series Evals To Resolve" }, "annotations": { "additionalProperties": true, "title": "Annotations", "type": "object" }, "labels": { "additionalProperties": true, "title": "Labels", "type": "object" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Paused" }, "folder_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Uid" }, "rule_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rule Group" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" }, "notification_settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Notification Settings" }, "record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Record" } }, "title": "AlertRule", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "rule": { "anyOf": [ { "$ref": "#/$defs/AlertRule" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "CreateAlertRuleOutput", "type": "object" } ``` ### Parameters The UID of the alert rule to update New title for the alert rule New folder UID for the rule New rule group name New condition refId New JSON array of query/expression data objects Duration to wait before firing (e.g. 5m, 1h) State when no data is returned (NoData, Alerting, OK) State on execution error (Error, Alerting, OK) JSON object of annotations JSON object of labels Whether the rule is paused Duration to keep firing after the condition stops Missing series evaluations before resolving JSON object of per-rule notification settings JSON object configuring this as a recording rule Set the X-Disable-Provenance header so the rule stays UI-editable Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "AlertRule": { "additionalProperties": false, "description": "A provisioned alert rule (shared by list/get/create/update).", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "condition": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Condition" }, "data": { "items": {}, "title": "Data", "type": "array" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "no_data_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "No Data State" }, "exec_err_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exec Err State" }, "for_": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "For" }, "keep_firing_for": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Keep Firing For" }, "missing_series_evals_to_resolve": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Missing Series Evals To Resolve" }, "annotations": { "additionalProperties": true, "title": "Annotations", "type": "object" }, "labels": { "additionalProperties": true, "title": "Labels", "type": "object" }, "is_paused": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Paused" }, "folder_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Folder Uid" }, "rule_group": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rule Group" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" }, "notification_settings": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Notification Settings" }, "record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Record" } }, "title": "AlertRule", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "rule": { "anyOf": [ { "$ref": "#/$defs/AlertRule" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "UpdateAlertRuleOutput", "type": "object" } ``` ### Parameters The UID of the alert rule to delete Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "DeleteAlertRuleOutput", "type": "object" } ``` ### Parameters Filter contact points by exact name match Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "ContactPoint": { "additionalProperties": false, "description": "A single notification contact point.", "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "settings": { "additionalProperties": true, "title": "Settings", "type": "object" }, "disable_resolve_message": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Disable Resolve Message" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" } }, "title": "ContactPoint", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "contact_points": { "items": { "$ref": "#/$defs/ContactPoint" }, "title": "Contact Points", "type": "array" } }, "required": [ "success" ], "title": "ListContactPointsOutput", "type": "object" } ``` ### Parameters Name of the contact point Receiver type (e.g. slack, email, pagerduty, webhook, teams, opsgenie, discord) JSON object of type-specific receiver settings Do not send a notification when the alert resolves Set the X-Disable-Provenance header so the contact point stays UI-editable Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "settings": { "additionalProperties": true, "title": "Settings", "type": "object" }, "disable_resolve_message": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Disable Resolve Message" }, "provenance": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Provenance" } }, "required": [ "success" ], "title": "CreateContactPointOutput", "type": "object" } ``` ### Parameters The text content of the annotation Comma-separated list of tags UID of the dashboard to annotate; omit for a global annotation ID of the panel to attach the annotation to Start time in epoch milliseconds (defaults to now) End time in epoch milliseconds for range annotations Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "CreateAnnotationOutput", "type": "object" } ``` ### Parameters Start time in epoch milliseconds End time in epoch milliseconds Dashboard UID to query annotations from Legacy numeric dashboard ID filter Filter by panel ID Filter by alert ID Filter by ID of the creating user Comma-separated list of tags to filter by Filter by type (alert or annotation) Maximum number of annotations to return Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "Annotation": { "additionalProperties": false, "description": "A single annotation row from ``/api/annotations``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "alert_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Alert Id" }, "dashboard_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Dashboard Id" }, "dashboard_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dashboard Uid" }, "panel_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Panel Id" }, "user_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "User Id" }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Name" }, "new_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "New State" }, "prev_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prev State" }, "time": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Time" }, "time_end": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Time End" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Text" }, "metric": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Metric" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "data": { "additionalProperties": true, "title": "Data", "type": "object" } }, "title": "Annotation", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "annotations": { "items": { "$ref": "#/$defs/Annotation" }, "title": "Annotations", "type": "array" } }, "required": [ "success" ], "title": "ListAnnotationsOutput", "type": "object" } ``` ### Parameters The ID of the annotation to update New text content for the annotation Comma-separated list of new tags New start time in epoch milliseconds New end time in epoch milliseconds Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "UpdateAnnotationOutput", "type": "object" } ``` ### Parameters The ID of the annotation to delete Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "DeleteAnnotationOutput", "type": "object" } ``` ### Parameters Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "DataSource": { "additionalProperties": false, "description": "A single data source from ``/api/datasources``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "type_logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type Logo Url" }, "access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Access" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Database" }, "basic_auth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Basic Auth" }, "basic_auth_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Basic Auth User" }, "with_credentials": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "With Credentials" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Default" }, "json_data": { "additionalProperties": true, "title": "Json Data", "type": "object" }, "secure_json_fields": { "additionalProperties": true, "title": "Secure Json Fields", "type": "object" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" }, "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Read Only" } }, "title": "DataSource", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "data_sources": { "items": { "$ref": "#/$defs/DataSource" }, "title": "Data Sources", "type": "array" } }, "required": [ "success" ], "title": "ListDataSourcesOutput", "type": "object" } ``` ### Parameters The ID or UID of the data source to retrieve Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "DataSource": { "additionalProperties": false, "description": "A single data source from ``/api/datasources``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "org_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Org Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type" }, "type_logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Type Logo Url" }, "access": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Access" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Database" }, "basic_auth": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Basic Auth" }, "basic_auth_user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Basic Auth User" }, "with_credentials": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "With Credentials" }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Is Default" }, "json_data": { "additionalProperties": true, "title": "Json Data", "type": "object" }, "secure_json_fields": { "additionalProperties": true, "title": "Secure Json Fields", "type": "object" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" }, "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Read Only" } }, "title": "DataSource", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "data_source": { "anyOf": [ { "$ref": "#/$defs/DataSource" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "GetDataSourceOutput", "type": "object" } ``` ### Parameters The UID of the data source to health-check Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "CheckDataSourceHealthOutput", "type": "object" } ``` ### Parameters Maximum number of folders to return Page number for pagination List children of this folder UID Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "Folder": { "additionalProperties": false, "description": "A single folder from ``/api/folders``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "parent_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Uid" }, "parents": { "items": { "$ref": "#/$defs/FolderParent" }, "title": "Parents", "type": "array" }, "has_acl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Acl" }, "can_save": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Save" }, "can_edit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Edit" }, "can_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Admin" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" } }, "title": "Folder", "type": "object" }, "FolderParent": { "additionalProperties": false, "description": "An ancestor folder entry (nested folders only).", "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "FolderParent", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "folders": { "items": { "$ref": "#/$defs/Folder" }, "title": "Folders", "type": "array" } }, "required": [ "success" ], "title": "ListFoldersOutput", "type": "object" } ``` ### Parameters The title of the new folder Optional UID for the folder Parent folder UID for nested folders Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "Folder": { "additionalProperties": false, "description": "A single folder from ``/api/folders``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "parent_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Uid" }, "parents": { "items": { "$ref": "#/$defs/FolderParent" }, "title": "Parents", "type": "array" }, "has_acl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Acl" }, "can_save": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Save" }, "can_edit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Edit" }, "can_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Admin" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" } }, "title": "Folder", "type": "object" }, "FolderParent": { "additionalProperties": false, "description": "An ancestor folder entry (nested folders only).", "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "FolderParent", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "folder": { "anyOf": [ { "$ref": "#/$defs/Folder" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "CreateFolderOutput", "type": "object" } ``` ### Parameters The UID of the folder to retrieve Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "Folder": { "additionalProperties": false, "description": "A single folder from ``/api/folders``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "parent_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Uid" }, "parents": { "items": { "$ref": "#/$defs/FolderParent" }, "title": "Parents", "type": "array" }, "has_acl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Acl" }, "can_save": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Save" }, "can_edit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Edit" }, "can_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Admin" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" } }, "title": "Folder", "type": "object" }, "FolderParent": { "additionalProperties": false, "description": "An ancestor folder entry (nested folders only).", "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "FolderParent", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "folder": { "anyOf": [ { "$ref": "#/$defs/Folder" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "GetFolderOutput", "type": "object" } ``` ### Parameters The UID of the folder to update New title for the folder Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "$defs": { "Folder": { "additionalProperties": false, "description": "A single folder from ``/api/folders``.", "properties": { "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" }, "parent_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Uid" }, "parents": { "items": { "$ref": "#/$defs/FolderParent" }, "title": "Parents", "type": "array" }, "has_acl": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Has Acl" }, "can_save": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Save" }, "can_edit": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Edit" }, "can_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Can Admin" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created By" }, "created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Created" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated By" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Updated" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Version" } }, "title": "Folder", "type": "object" }, "FolderParent": { "additionalProperties": false, "description": "An ancestor folder entry (nested folders only).", "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Title" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Url" } }, "title": "FolderParent", "type": "object" } }, "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "folder": { "anyOf": [ { "$ref": "#/$defs/Folder" }, { "type": "null" } ], "default": null } }, "required": [ "success" ], "title": "UpdateFolderOutput", "type": "object" } ``` ### Parameters The UID of the folder to delete Delete any alert rules stored in the folder along with it Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Uid" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Message" } }, "required": [ "success" ], "title": "DeleteFolderOutput", "type": "object" } ``` ### Parameters Organization ID for multi-org Grafana instances (e.g. 1, 2). Sent as the X-Grafana-Org-Id header when set. ### Response ```json theme={null} { "additionalProperties": false, "properties": { "success": { "title": "Success", "type": "boolean" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Error" }, "commit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Commit" }, "database": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Database" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Version" } }, "required": [ "success" ], "title": "GetHealthOutput", "type": "object" } ``` ## Limits & Quotas * **Rate limits** are configured per Grafana instance; self-hosted instances are unbounded by default, while Grafana Cloud applies tier limits. * **Update semantics**: `update_dashboard`, `update_alert_rule`, and `update_folder` first `GET` the current resource, merge your changes, and write the full body back (Grafana's update endpoints require the complete resource and a version for conflict detection). * **Error model**: non-2xx responses and timeouts are caught and returned as `success=False` + `error` rather than raising. Plan for retries on the agent side based on the error string. ## Related integrations ## Links * [Grafana](https://grafana.com)