Grafana integration

Overview

Grafana is an open-source monitoring and observability platform. This tool interacts with the Grafana HTTP API to manage dashboards (create, get, update, delete), teams (create, get, update, delete), team members (add, list, remove), and organization users (create, delete, list, update roles). It uses bearer token authentication with a Grafana API key.

Node Type

Action — processes input items and produces output

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires Grafana API credentials. See the Credentials Guide for setup instructions.

Resources

Resource	Value
Dashboard	dashboard
Team	team
Team Member	teamMember
User	user

Operations

Each resource has its own Operation list, and several resources reuse the same operation values (create, delete, get, getAll, update). Pick the resource first, then the operation.

Resource	Operation	Value	Description
Dashboard	Create	create	Create a dashboard
Dashboard	Delete	delete	Delete a dashboard
Dashboard	Get	get	Get a dashboard
Dashboard	Get Many	getAll	Get many dashboards
Dashboard	Update	update	Update a dashboard
Team	Create	create	Create a team
Team	Delete	delete	Delete a team
Team	Get	get	Get a team
Team	Get Many	getAll	Get many teams
Team	Update	update	Update a team
Team Member	Add	add	Add a member to a team
Team Member	Get Many	getAll	Get many team members
Team Member	Remove	remove	Remove a member from a team
User	Create	create	Add a user to the current organization
User	Delete	delete	Delete a user from the current organization
User	Get Many	getAll	Get many users in the current organization
User	Update	update	Update a user in the current organization

Parameters

Every parameter accepts expressions, so IDs and names can be driven from the incoming item. User operations act on the organization the API key belongs to.

Dashboard: Create

Parameter	Type	Required	Default	Description
Title	string	Yes	—	Title of the dashboard to create.
Additional Fields (additionalFields)	collection	No	{}	Optional properties for the new dashboard.
— Folder ID (folderId)	string	No	—	ID of the folder to create the dashboard in. If unspecified, the dashboard is saved to the General folder. Find folder IDs by calling GET /api/folders on your Grafana instance.

Dashboard: Delete

Parameter	Type	Required	Default	Description
Dashboard UID or URL (dashboardUidOrUrl)	string	Yes	—	Unique alphabetic identifier or full Grafana URL of the dashboard.

Dashboard: Get

Parameter	Type	Required	Default	Description
Dashboard UID or URL (dashboardUidOrUrl)	string	Yes	—	Unique alphabetic identifier or full Grafana URL of the dashboard to retrieve.

Dashboard: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return (1–100). (shown when Return All is false)
Filters	collection	No	{}	Narrow the listing.
— Search Query (query)	string	No	—	Search query to filter dashboards by name.

Dashboard: Update

Parameter	Type	Required	Default	Description
Dashboard UID or URL (dashboardUidOrUrl)	string	Yes	—	Unique alphabetic identifier or full Grafana URL of the dashboard to update.
Update Fields	collection	No	{}	Fields to change. Add at least one — the item fails if this is empty.
— Folder ID (folderId)	string	No	—	ID of the folder to move the dashboard into. If unspecified, the dashboard stays in its current folder.
— Title (title)	string	No	—	New title for the dashboard.

Team: Create

Parameter	Type	Required	Default	Description
Name	string	Yes	—	Name of the team to create.
Additional Fields (additionalFields)	collection	No	{}	Optional properties for the new team.
— Email (email)	string	No	—	Email address for the team.

Team: Delete

Parameter	Type	Required	Default	Description
Team ID	string	Yes	—	ID of the team to delete.

Team: Get

Parameter	Type	Required	Default	Description
Team ID	string	Yes	—	ID of the team to retrieve.

Team: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)
Filters	collection	No	{}	Narrow the listing.
— Name (name)	string	No	—	Filter teams by name.

Team: Update

Parameter	Type	Required	Default	Description
Team ID	string	Yes	—	ID of the team to update.
Update Fields	collection	No	{}	Fields to change. Only the fields you add are sent.
— Email (email)	string	No	—	New email address for the team.
— Name (name)	string	No	—	New name for the team.

Team Member: Add

Parameter	Type	Required	Default	Description
User ID (userId)	string	Yes	—	ID of the user to add to the team. Find user IDs via the user getAll operation or GET /api/org/users.
Team ID	string	Yes	—	ID of the team to add the user to. Find team IDs via the team getAll operation or GET /api/teams/search.

Team Member: Get Many

Parameter	Type	Required	Default	Description
Team ID	string	Yes	—	ID of the team to retrieve members from.
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)

Team Member: Remove

Parameter	Type	Required	Default	Description
User ID (memberId)	string	Yes	—	ID of the user to remove from the team. Note the internal name differs from the Add operation’s User ID.
Team ID	string	Yes	—	ID of the team to remove the user from.

User: Create

Parameter	Type	Required	Default	Description
Role	options	Yes	Viewer	Role to assign to the user in the organization.
				Options: Admin, Editor, Viewer
Login or Email (loginOrEmail)	string	Yes	—	Login name or email address of the user to add to the organization.

User: Delete

Parameter	Type	Required	Default	Description
User ID (userId)	string	Yes	—	ID of the user to delete from the organization.

User: Get Many

Parameter	Type	Required	Default	Description
Return All	boolean	No	false	Whether to return all results or only up to a given limit.
Limit	number	No	50	Max number of results to return. (shown when Return All is false)

User: Update

Parameter	Type	Required	Default	Description
User ID (userId)	string	Yes	—	ID of the user to update.
Update Fields	collection	No	{}	Fields to change. Add at least one — the item fails if this is empty.
— Role (role)	options	No	Admin	New role for the user in the organization.
				Options: Admin, Editor, Viewer

All Operations

Parameter	Type	Required	Default	Description
Max Concurrency	number	No	10	Maximum number of items to process concurrently (1–100).

Output Data

The Grafana response is merged onto the input item’s JSON at the top level — the fields the item already carried survive, and a response key with the same name overwrites the item’s value. Binary data on the input item is forwarded unchanged.

The number of output items follows the shape of the reply: an array reply fans out to one output item per entry, and any other reply produces exactly one output item.

Operation	Output
Dashboard Get Many, Team Get Many, Team Member Get Many, User Get Many	One output item per dashboard, team, member or user. A listing that matches nothing produces no output items at all, so that branch of the workflow simply stops.
Dashboard Create, Dashboard Update	One output item carrying Grafana’s save response for the dashboard.
Dashboard Get, Team Get	One output item carrying the record.
Dashboard Delete, Team Create, Team Delete, Team Update, Team Member Add, Team Member Remove, User Create, User Delete, User Update	One output item carrying Grafana’s confirmation for that call.

Example Configuration

Create a dashboard in a folder:

{
  "type": "grafana",
  "parameters": {
    "resource": "dashboard",
    "operation": "create",
    "title": "{{ $json.serviceName }} overview",
    "additionalFields": {
      "folderId": "12"
    }
  }
}

Search dashboards by name, one item each:

{
  "type": "grafana",
  "parameters": {
    "resource": "dashboard",
    "operation": "getAll",
    "returnAll": false,
    "limit": 50,
    "filters": {
      "query": "monitoring"
    }
  }
}

Rename a dashboard and move it to another folder:

{
  "type": "grafana",
  "parameters": {
    "resource": "dashboard",
    "operation": "update",
    "dashboardUidOrUrl": "abc123def",
    "updateFields": {
      "title": "Updated Dashboard Title",
      "folderId": "14"
    }
  }
}

Delete a dashboard by the URL someone pasted into the item:

{
  "type": "grafana",
  "parameters": {
    "resource": "dashboard",
    "operation": "delete",
    "dashboardUidOrUrl": "{{ $json.dashboardUrl }}"
  }
}

Create a team with a contact address:

{
  "type": "grafana",
  "parameters": {
    "resource": "team",
    "operation": "create",
    "name": "Development Team",
    "additionalFields": {
      "email": "dev-team@company.com"
    }
  }
}

Add a user to a team:

{
  "type": "grafana",
  "parameters": {
    "resource": "teamMember",
    "operation": "add",
    "userId": "15",
    "teamId": "5"
  }
}

Remove a user from a team — note the field is memberId here:

{
  "type": "grafana",
  "parameters": {
    "resource": "teamMember",
    "operation": "remove",
    "memberId": "15",
    "teamId": "5"
  }
}

Invite an existing Grafana user into the organization as an editor:

{
  "type": "grafana",
  "parameters": {
    "resource": "user",
    "operation": "create",
    "role": "Editor",
    "loginOrEmail": "{{ $json.email }}"
  }
}

Promote a user to admin:

{
  "type": "grafana",
  "parameters": {
    "resource": "user",
    "operation": "update",
    "userId": "{{ $json.userId }}",
    "updateFields": {
      "role": "Admin"
    }
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

This tool manages Grafana dashboards, teams, team members, and users. It is ideal for creating, deleting, getting, updating, adding, listing, or removing these resources within a Grafana instance. It produces confirmation of actions, details of retrieved resources, or lists of resources.

• Dashboards are addressed by UID. The field accepts the bare UID or the full dashboard URL and pulls the UID out of it, so you can paste a link straight from a browser.
• Update needs at least one field. Dashboard Update and User Update fail the item when their fields collection is empty, rather than making a no-op call.
• Two different User ID fields. Team Member: Add uses userId; Team Member: Remove uses memberId. They look identical in the panel but are different keys in a JSON config.
• Dashboard Update overwrites. The node re-saves the dashboard with the fields you supplied, so it checks the dashboard exists first and fails the item if it does not.
• A connection error reads as a credential problem. If the instance is unreachable the node reports “Invalid credentials or error in establishing connection with given credentials” — check the base URL as well as the key.