Appearance
Grafana
Manage dashboards, data sources, and alerts with the Grafana HTTP API.
| Detail | Value |
|---|---|
| Category | Monitoring |
| Base URL | https://grafana.example.com/api |
| Authentication | Bearer Token |
| Endpoints | 8 |
| Connector key | grafana |
Using Grafana in a workflow
- Go to Connections and click New Connection.
- Pick Grafana from the marketplace.
- Enter your credentials (see Authentication above for what's expected).
- In a workflow, drop an API Call node and select this connection.
- Pick the operation you need from the Operation dropdown. The full list is below.
Available endpoints
| Endpoint | Summary |
|---|---|
POST /dashboards/db | Create or update dashboard |
GET /dashboards/uid/{uid} | Get dashboard by UID |
GET /search | Search dashboards |
GET /datasources | List data sources |
POST /datasources | Create a data source |
GET /alerts | List alerts |
GET /folders | List folders |
GET /org | Get current org |
Each endpoint is documented in full below. Use the outline on the right to jump to one.
POST /dashboards/db
Create or update dashboard
| Detail | Value |
|---|---|
| Operation ID | monitoring.createOrUpdateDashboard |
| Method | POST |
| Path | /dashboards/db |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.createOrUpdateDashboard. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /dashboards/uid/{uid}
Get dashboard by UID
| Detail | Value |
|---|---|
| Operation ID | monitoring.getDashboardByUid |
| Method | GET |
| Path | /dashboards/uid/{uid} |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.getDashboardByUid. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /search
Search dashboards
| Detail | Value |
|---|---|
| Operation ID | monitoring.searchDashboards |
| Method | GET |
| Path | /search |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.searchDashboards. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /datasources
List data sources
| Detail | Value |
|---|---|
| Operation ID | monitoring.listDataSources |
| Method | GET |
| Path | /datasources |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.listDataSources. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
POST /datasources
Create a data source
| Detail | Value |
|---|---|
| Operation ID | monitoring.createDataSource |
| Method | POST |
| Path | /datasources |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.createDataSource. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /alerts
List alerts
| Detail | Value |
|---|---|
| Operation ID | monitoring.listAlerts |
| Method | GET |
| Path | /alerts |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.listAlerts. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /folders
List folders
| Detail | Value |
|---|---|
| Operation ID | monitoring.listFolders |
| Method | GET |
| Path | /folders |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.listFolders. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.
GET /org
Get current org
| Detail | Value |
|---|---|
| Operation ID | monitoring.getCurrentOrg |
| Method | GET |
| Path | /org |
Parameters
No parameters.
Using this endpoint in a workflow
- Add an API Call node to your workflow.
- Pick your Grafana connection from the Connection dropdown.
- In the Operation dropdown, select
monitoring.getCurrentOrg. - Fill in the parameter fields that appear. Use
{{...}}to reference upstream values.
What it returns
The API Call node writes the response to the workflow context:
{
status: 200,
success: true,
data: { ...response body from the API... },
latencyMs: 142
}Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Grafana API reference.