Skip to main content

Grafana Query

Type ID: grafanaQuery  ·  Kind: Action  ·  Ports: 1 in, 1 out

Run ad-hoc queries against a Grafana data source.

Credentials​

Grafana (Service Account Token)

{
"credentials": {
"name": "grafana",
"id": "<credential-id>"
}
}

Resources & operations​

  • Query (query)
    • Query Data Source (queryDataSource) - Run an ad-hoc query against a configured Grafana data source

For agent integrations (name: 'grafanaQuery' in permissions.integrations), grant '*', a resource key, or an operation key — see Tools and Permissions:

Resource key (<resource>)Operation keys (<resource>.<operation>)
queryquery.queryDataSource

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsYesqueryQuery (query)-
OperationoperationoptionsYesqueryDataSourceQuery Data Source (queryDataSource)resource = query

Query → Query Data Source​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Data Source UIDdatasourceUidstringYes''UID of the Grafana data source to query (e.g. a Prometheus or PostgreSQL data source already configured in Grafana)resource = query, operation = queryDataSource
QueryqueryjsonYes{}Data-source-specific query object merged into the request target, for example { "expr": "up", "refId": "A" } for Prometheus or { "rawSql": "select 1", "refId": "A" } for SQL sourcesresource = query, operation = queryDataSource
FromfromstringNonow-1hRange start, Grafana time syntax (e.g. now-1h) or epoch millis stringresource = query, operation = queryDataSource
TotostringNonowRange end, Grafana time syntax (e.g. now) or epoch millis stringresource = query, operation = queryDataSource

Notes​

  • Query Data Source output: { results, raw }.