Grafana

Interact with a Grafana instance via its HTTP API. Search dashboards, retrieve dashboard details, list data sources, and list provisioned alert rules.

Operations

API Key Setup

1. In Grafana, go to Administration > Users and access > Service Accounts.
2. Create a service account with the Viewer role (or Editor if you need write access in future).
3. Click Add service account token and copy the generated token.
4. Pass the token as apiKey in the tool input.

Authentication uses Authorization: Bearer <token> as documented at https://grafana.com/docs/grafana/latest/developers/http_api/auth/.

Examples

Search for dashboards containing "nginx":

{
  "apiKey": "glsa_xxxx",
  "grafanaUrl": "http://grafana.example.com:3000",
  "operation": "search-dashboards",
  "query": "nginx"
}

Get a specific dashboard:

{
  "apiKey": "glsa_xxxx",
  "grafanaUrl": "http://grafana.example.com:3000",
  "operation": "get-dashboard",
  "dashboardUid": "abc123def"
}

List all data sources:

{
  "apiKey": "glsa_xxxx",
  "grafanaUrl": "http://grafana.example.com:3000",
  "operation": "list-datasources"
}

List alert rules:

{
  "apiKey": "glsa_xxxx",
  "grafanaUrl": "http://grafana.example.com:3000",
  "operation": "list-alert-rules"
}

Notes

• grafanaUrl must include the scheme and port (e.g. http://localhost:3000) with no trailing slash.
• The list-alert-rules operation requires Grafana 9+ and the Alerting feature enabled.
• Responses are returned as a JSON string in the result publish variable.
• Body reads are capped at 5 MB.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.