Can I use Grafana as a CLI?

Yes. KosmoKrator exposes a Grafana CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Grafana through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Grafana tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Grafana credentials stored?

Grafana credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Grafana MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

analytics

Grafana Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Grafana KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.grafana.*. Use lua_read_doc("integrations.grafana") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Grafana workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.grafana.get_all_roles({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("grafana"))' --json
kosmo integrations:lua --eval 'print(docs.read("grafana.get_all_roles"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local grafana = app.integrations.grafana
local result = grafana.get_all_roles({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.grafana, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.grafana.default.* or app.integrations.grafana.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Grafana, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Grafana Lua API Reference

Namespace: grafana

This integration exposes generated coverage for Grafana’s official HTTP API OpenAPI document. Configure the API base URL with the /api prefix, for example https://grafana.example.test/api or http://localhost:3000/api.

Authentication uses a Grafana service account token or a legacy API key where older deployments still allow API keys. Grafana permissions are enforced by the instance, so a token may see only the dashboards, folders, data sources, teams, alerts, reports, or RBAC resources it is allowed to access.

Common Tools

grafana_list_dashboards maps to GET /search and searches dashboards and folders.
grafana_get_dashboard maps to GET /dashboards/uid/{uid}.
grafana_create_dashboard maps to POST /dashboards/db.
grafana_list_datasources maps to GET /datasources.
grafana_list_alerts maps to GET /v1/provisioning/alert-rules.
grafana_list_teams maps to GET /teams/search.
grafana_get_current_user maps to GET /user.

The package also exposes generated tools for folders, annotations, dashboard versions, permissions, snapshots, playlist APIs, library elements, reports, public dashboards, teams, orgs, users, service accounts, access-control roles, alerting provisioning, query history, data source proxy calls, and admin/provisioning endpoints.

Arguments

Path, query, and header parameters use the names from Grafana’s OpenAPI document. The runtime also accepts snake_case aliases for camel-case names. For example, roleUID, role_uid, and roleuid resolve to the same path parameter.

Tools with a JSON request body accept a body table. If you omit body, non-path/query/header arguments are collected into the request body.

YAML-only endpoints accept body as a raw YAML string.

Examples

local dashboards = grafana.grafana_list_dashboards({
  query = "latency",
  type = "dash-db",
  limit = 25
})

local dashboard = grafana.grafana_get_dashboard({
  uid = "service-latency"
})

local result = grafana.grafana_create_dashboard({
  body = {
    dashboard = {
      uid = "agent-demo",
      title = "Agent Demo",
      panels = {}
    },
    overwrite = true
  }
})

local rules = grafana.grafana_list_alerts({})

Return Shapes

Responses are Grafana’s parsed JSON responses with no private host rewriting. Non-JSON responses return:

{
  body = "...",
  content_type = "text/csv"
}

Grafana editions and plugin sets differ. Enterprise-only endpoints, report endpoints, LDAP/SAML endpoints, or newer alerting endpoints may return authorization or not-found errors on instances that do not support them.

Raw agent markdown

# Grafana Lua API Reference

Namespace: `grafana`

This integration exposes generated coverage for Grafana's official HTTP API OpenAPI document. Configure the API base URL with the `/api` prefix, for example `https://grafana.example.test/api` or `http://localhost:3000/api`.

Authentication uses a Grafana service account token or a legacy API key where older deployments still allow API keys. Grafana permissions are enforced by the instance, so a token may see only the dashboards, folders, data sources, teams, alerts, reports, or RBAC resources it is allowed to access.

## Common Tools

- `grafana_list_dashboards` maps to `GET /search` and searches dashboards and folders.
- `grafana_get_dashboard` maps to `GET /dashboards/uid/{uid}`.
- `grafana_create_dashboard` maps to `POST /dashboards/db`.
- `grafana_list_datasources` maps to `GET /datasources`.
- `grafana_list_alerts` maps to `GET /v1/provisioning/alert-rules`.
- `grafana_list_teams` maps to `GET /teams/search`.
- `grafana_get_current_user` maps to `GET /user`.

The package also exposes generated tools for folders, annotations, dashboard versions, permissions, snapshots, playlist APIs, library elements, reports, public dashboards, teams, orgs, users, service accounts, access-control roles, alerting provisioning, query history, data source proxy calls, and admin/provisioning endpoints.

## Arguments

Path, query, and header parameters use the names from Grafana's OpenAPI document. The runtime also accepts snake_case aliases for camel-case names. For example, `roleUID`, `role_uid`, and `roleuid` resolve to the same path parameter.

Tools with a JSON request body accept a `body` table. If you omit `body`, non-path/query/header arguments are collected into the request body.

YAML-only endpoints accept `body` as a raw YAML string.

## Examples

```lua
local dashboards = grafana.grafana_list_dashboards({
  query = "latency",
  type = "dash-db",
  limit = 25
})
```

```lua
local dashboard = grafana.grafana_get_dashboard({
  uid = "service-latency"
})
```

```lua
local result = grafana.grafana_create_dashboard({
  body = {
    dashboard = {
      uid = "agent-demo",
      title = "Agent Demo",
      panels = {}
    },
    overwrite = true
  }
})
```

```lua
local rules = grafana.grafana_list_alerts({})
```

## Return Shapes

Responses are Grafana's parsed JSON responses with no private host rewriting. Non-JSON responses return:

```lua
{
  body = "...",
  content_type = "text/csv"
}
```

Grafana editions and plugin sets differ. Enterprise-only endpoints, report endpoints, LDAP/SAML endpoints, or newer alerting endpoints may return authorization or not-found errors on instances that do not support them.

Metadata-derived Lua example

local result = app.integrations.grafana.get_all_roles({})
print(result)

Functions

get_all_roles Read

Gets all existing roles. The response contains all global and organization local roles, for the organization which user is signed in. You need to have a permission with action `roles:read` and scope `roles:*`. The `delegatable` flag reduces the set of roles to only those for which the signed-in user has permissions to assign.

Lua path: app.integrations.grafana.get_all_roles
Full name: grafana.grafana_list_roles

Parameter	Type	Required	Description
No parameters.

create_new_custom_role Write

Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as Fixed Roles can't be created. You need to have a permission with action `roles:write` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only create custom roles with the same, or a subset of permissions which the user has. For example, if a use...

Lua path: app.integrations.grafana.create_new_custom_role
Full name: grafana.grafana_create_role

Parameter	Type	Required	Description
No parameters.

delete_custom_role Write

Delete a role with the given UID, and it's permissions. If the role is assigned to a built-in role, the deletion operation will fail, unless force query param is set to true, and in that case all assignments will also be deleted. You need to have a permission with action `roles:delete` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only delete a...

Lua path: app.integrations.grafana.delete_custom_role
Full name: grafana.grafana_delete_role

Parameter	Type	Required	Description
No parameters.

get_role Read

Get a role for the given UID. You need to have a permission with action `roles:read` and scope `roles:*`.

Lua path: app.integrations.grafana.get_role
Full name: grafana.grafana_get_role

Parameter	Type	Required	Description
No parameters.

update_custom_role Write

You need to have a permission with action `roles:write` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only create custom roles with the same, or a subset of permissions which the user has.

Lua path: app.integrations.grafana.update_custom_role
Full name: grafana.grafana_update_role

Parameter	Type	Required	Description
No parameters.

get_role_assignments Read

Get role assignments for the role with the given UID. Does not include role assignments mapped through group attribute sync. You need to have a permission with action `teams.roles:list` and scope `teams:id:*` and `users.roles:list` and scope `users:id:*`.

Lua path: app.integrations.grafana.get_role_assignments
Full name: grafana.grafana_get_role_assignments

Parameter	Type	Required	Description
No parameters.

set_role_assignments Write

Set role assignments for the role with the given UID. You need to have a permission with action `teams.roles:add` and `teams.roles:remove` and scope `permissions:type:delegate`, and `users.roles:add` and `users.roles:remove` and scope `permissions:type:delegate`.

Lua path: app.integrations.grafana.set_role_assignments
Full name: grafana.grafana_set_role_assignments

Parameter	Type	Required	Description
No parameters.

get_status Read

Returns an indicator to check if fine-grained access control is enabled or not. You need to have a permission with action `status:accesscontrol` and scope `services:accesscontrol`.

Lua path: app.integrations.grafana.get_status
Full name: grafana.grafana_get_access_control_status

Parameter	Type	Required	Description
No parameters.

list_roles_assigned_multiple_teams Write

Lists the roles that have been directly assigned to the given teams. You need to have a permission with action `teams.roles:read` and scope `teams:id:*`.

Lua path: app.integrations.grafana.list_roles_assigned_multiple_teams
Full name: grafana.grafana_list_teams_roles

Parameter	Type	Required	Description
No parameters.

get_team_roles Read

You need to have a permission with action `teams.roles:read` and scope `teams:id:<team ID>`.

Lua path: app.integrations.grafana.get_team_roles
Full name: grafana.grafana_list_team_roles

Parameter	Type	Required	Description
No parameters.

add_team_role Write

You need to have a permission with action `teams.roles:add` and scope `permissions:type:delegate`.

Lua path: app.integrations.grafana.add_team_role
Full name: grafana.grafana_add_team_role

Parameter	Type	Required	Description
No parameters.

update_team_role Write

You need to have a permission with action `teams.roles:add` and `teams.roles:remove` and scope `permissions:type:delegate` for each.

Lua path: app.integrations.grafana.update_team_role
Full name: grafana.grafana_set_team_roles

Parameter	Type	Required	Description
No parameters.

remove_team_role Write

You need to have a permission with action `teams.roles:remove` and scope `permissions:type:delegate`.

Lua path: app.integrations.grafana.remove_team_role
Full name: grafana.grafana_remove_team_role

Parameter	Type	Required	Description
No parameters.

list_roles_assigned_multiple_users Write

Lists the roles that have been directly assigned to the given users. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team. You need to have a permission with action `users.roles:read` and scope `users:id:*`.

Lua path: app.integrations.grafana.list_roles_assigned_multiple_users
Full name: grafana.grafana_list_users_roles

Parameter	Type	Required	Description
No parameters.

list_roles_assigned_user Read

Lists the roles that have been directly assigned to a given user. The list does not include built-in roles (Viewer, Editor, Admin or Grafana Admin), and it does not include roles that have been inherited from a team. You need to have a permission with action `users.roles:read` and scope `users:id:<user ID>`.

Lua path: app.integrations.grafana.list_roles_assigned_user
Full name: grafana.grafana_list_user_roles

Parameter	Type	Required	Description
No parameters.

add_user_role_assignment Write

Assign a role to a specific user. For bulk updates consider Set user role assignments. You need to have a permission with action `users.roles:add` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only assign roles which have same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating u...

Lua path: app.integrations.grafana.add_user_role_assignment
Full name: grafana.grafana_add_user_role

Parameter	Type	Required	Description
No parameters.

set_user_role_assignments Write

Update the user's role assignments to match the provided set of UIDs. This will remove any assigned roles that aren't in the request and add roles that are in the set but are not already assigned to the user. Roles mapped through group attribute sync are not impacted. If you want to add or remove a single role, consider using Add a user role assignment or Remove a user role assignment instead...

Lua path: app.integrations.grafana.set_user_role_assignments
Full name: grafana.grafana_set_user_roles

Parameter	Type	Required	Description
No parameters.

remove_user_role_assignment Write

Revoke a role from a user. For bulk updates consider Set user role assignments. You need to have a permission with action `users.roles:remove` and scope `permissions:type:delegate`. `permissions:type:delegate` scope ensures that users can only unassign roles which have same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating use...

Lua path: app.integrations.grafana.remove_user_role_assignment
Full name: grafana.grafana_remove_user_role

Parameter	Type	Required	Description
No parameters.

get_description_resource_access_control_properties Read

Get a description of a resource's access control properties. (GET /access-control/{resource}/description).

Lua path: app.integrations.grafana.get_description_resource_access_control_properties
Full name: grafana.grafana_get_resource_description

Parameter	Type	Required	Description
No parameters.

get_permissions_resource Read

Get permissions for a resource. (GET /access-control/{resource}/{resourceID}).

Lua path: app.integrations.grafana.get_permissions_resource
Full name: grafana.grafana_get_resource_permissions

Parameter	Type	Required	Description
No parameters.

set_resource_permissions Write

Assigns permissions for a resource by a given type (`:resource`) and `:resourceID` to one or many assignment types. Allowed resources are `datasources`, `teams`, `dashboards`, `folders`, and `serviceaccounts`. Refer to the `/access-control/{resource}/description` endpoint for allowed Permissions.

Lua path: app.integrations.grafana.set_resource_permissions
Full name: grafana.grafana_set_resource_permissions

Parameter	Type	Required	Description
No parameters.

set_resource_permissions_built_role Write

Assigns permissions for a resource by a given type (`:resource`) and `:resourceID` to a built-in role. Allowed resources are `datasources`, `teams`, `dashboards`, `folders`, and `serviceaccounts`. Refer to the `/access-control/{resource}/description` endpoint for allowed Permissions.

Lua path: app.integrations.grafana.set_resource_permissions_built_role
Full name: grafana.grafana_set_resource_permissions_for_built_in_role

Parameter	Type	Required	Description
No parameters.

set_resource_permissions_team Write

Assigns permissions for a resource by a given type (`:resource`) and `:resourceID` to a team. Allowed resources are `datasources`, `teams`, `dashboards`, `folders`, and `serviceaccounts`. Refer to the `/access-control/{resource}/description` endpoint for allowed Permissions.

Lua path: app.integrations.grafana.set_resource_permissions_team
Full name: grafana.grafana_set_resource_permissions_for_team

Parameter	Type	Required	Description
No parameters.

set_resource_permissions_user Write

Assigns permissions for a resource by a given type (`:resource`) and `:resourceID` to a user or a service account. Allowed resources are `datasources`, `teams`, `dashboards`, `folders`, and `serviceaccounts`. Refer to the `/access-control/{resource}/description` endpoint for allowed Permissions.

Lua path: app.integrations.grafana.set_resource_permissions_user
Full name: grafana.grafana_set_resource_permissions_for_user

Parameter	Type	Required	Description
No parameters.

returns_current_state_ldap_background_sync_integration Read

You need to have a permission with action `ldap.status:read`.

Lua path: app.integrations.grafana.returns_current_state_ldap_background_sync_integration
Full name: grafana.grafana_get_sync_status

Parameter	Type	Required	Description
No parameters.

reloads_ldap_configuration Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.config:reload`.

Lua path: app.integrations.grafana.reloads_ldap_configuration
Full name: grafana.grafana_reload_l_d_a_p_cfg

Parameter	Type	Required	Description
No parameters.

attempts_connect_all_configured_ldap_servers_and_returns_information_whenever_they Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.status:read`.

Lua path: app.integrations.grafana.attempts_connect_all_configured_ldap_servers_and_returns_information_whenever_they
Full name: grafana.grafana_get_l_d_a_p_status

Parameter	Type	Required	Description
No parameters.

enables_single_user_be_synchronized_against_ldap Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.user:sync`.

Lua path: app.integrations.grafana.enables_single_user_be_synchronized_against_ldap
Full name: grafana.grafana_post_sync_user_with_l_d_a_p

Parameter	Type	Required	Description
No parameters.

finds_user_based_username_ldap_this_helps_illustrate_how_would_particular_user_be Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.user:read`.

Lua path: app.integrations.grafana.finds_user_based_username_ldap_this_helps_illustrate_how_would_particular_user_be
Full name: grafana.grafana_get_user_from_l_d_a_p

Parameter	Type	Required	Description
No parameters.

you_need_have_permission_with_action_provisioning_reload_with_scope_provisioners_accessco Write

You need to have a permission with action `provisioning:reload` with scope `provisioners:accessco... (POST /admin/provisioning/access-control/reload).

Lua path: app.integrations.grafana.you_need_have_permission_with_action_provisioning_reload_with_scope_provisioners_accessco
Full name: grafana.grafana_admin_provisioning_reload_access_control

Parameter	Type	Required	Description
No parameters.

reload_dashboard_provisioning_configurations Write

Reloads the provisioning config files for dashboards again. It won't return until the new provisioned entities are already stored in the database. In case of dashboards, it will stop polling for changes in dashboard files and then restart it with new configurations after returning. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission...

Lua path: app.integrations.grafana.reload_dashboard_provisioning_configurations
Full name: grafana.grafana_admin_provisioning_reload_dashboards

Parameter	Type	Required	Description
No parameters.

reload_datasource_provisioning_configurations Write

Reloads the provisioning config files for datasources again. It won't return until the new provisioned entities are already stored in the database. In case of dashboards, it will stop polling for changes in dashboard files and then restart it with new configurations after returning. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission...

Lua path: app.integrations.grafana.reload_datasource_provisioning_configurations
Full name: grafana.grafana_admin_provisioning_reload_datasources

Parameter	Type	Required	Description
No parameters.

reload_plugin_provisioning_configurations Write

Reloads the provisioning config files for plugins again. It won't return until the new provisioned entities are already stored in the database. In case of dashboards, it will stop polling for changes in dashboard files and then restart it with new configurations after returning. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission wit...

Lua path: app.integrations.grafana.reload_plugin_provisioning_configurations
Full name: grafana.grafana_admin_provisioning_reload_plugins

Parameter	Type	Required	Description
No parameters.

fetch_settings Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `settings:read` and scopes: `settings:*`, `settings:auth.saml:` and `settings:auth.saml:enabled` (property level).

Lua path: app.integrations.grafana.fetch_settings
Full name: grafana.grafana_admin_get_settings

Parameter	Type	Required	Description
No parameters.

fetch_stats Read

Only works with Basic Authentication (username and password). See introduction for an explanation. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `server:stats:read`.

Lua path: app.integrations.grafana.fetch_stats
Full name: grafana.grafana_admin_get_stats

Parameter	Type	Required	Description
No parameters.

create_new_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:create`. Note that OrgId is an optional parameter that can be used to assign a new user to a different organization when `auto_assign_org` is set to `true`.

Lua path: app.integrations.grafana.create_new_user
Full name: grafana.grafana_admin_create_user

Parameter	Type	Required	Description
No parameters.

delete_global_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global.users:*`.

Lua path: app.integrations.grafana.delete_global_user
Full name: grafana.grafana_admin_delete_user

Parameter	Type	Required	Description
No parameters.

return_list_all_auth_tokens_devices_that_user_currently_have_logged_from Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global.users:*`.

Lua path: app.integrations.grafana.return_list_all_auth_tokens_devices_that_user_currently_have_logged_from
Full name: grafana.grafana_admin_get_user_auth_tokens

Parameter	Type	Required	Description
No parameters.

disable_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global.users:1` (userIDScope).

Lua path: app.integrations.grafana.disable_user
Full name: grafana.grafana_admin_disable_user

Parameter	Type	Required	Description
No parameters.

enable_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global.users:1` (userIDScope).

Lua path: app.integrations.grafana.enable_user
Full name: grafana.grafana_admin_enable_user

Parameter	Type	Required	Description
No parameters.

logout_user_revokes_all_auth_tokens_devices_user_user_issued_auth_tokens_devices Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global.users:*`.

Lua path: app.integrations.grafana.logout_user_revokes_all_auth_tokens_devices_user_user_issued_auth_tokens_devices
Full name: grafana.grafana_admin_logout_user

Parameter	Type	Required	Description
No parameters.

set_password_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global.users:*`.

Lua path: app.integrations.grafana.set_password_user
Full name: grafana.grafana_admin_update_user_password

Parameter	Type	Required	Description
No parameters.

set_permissions_user Write

Lua path: app.integrations.grafana.set_permissions_user
Full name: grafana.grafana_admin_update_user_permissions

Parameter	Type	Required	Description
No parameters.

fetch_user_quota Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global.users:1` (userIDScope).

Lua path: app.integrations.grafana.fetch_user_quota
Full name: grafana.grafana_get_user_quota

Parameter	Type	Required	Description
No parameters.

update_user_quota Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global.users:1` (userIDScope).

Lua path: app.integrations.grafana.update_user_quota
Full name: grafana.grafana_update_user_quota

Parameter	Type	Required	Description
No parameters.

revoke_auth_token_user Write

Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity. If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global.users:*`.

Lua path: app.integrations.grafana.revoke_auth_token_user
Full name: grafana.grafana_admin_revoke_user_auth_token

Parameter	Type	Required	Description
No parameters.

find_annotations Read

Starting in Grafana v6.4 regions annotations are now returned in one entity that now includes the timeEnd property.

Lua path: app.integrations.grafana.find_annotations
Full name: grafana.grafana_get_annotations

Parameter	Type	Required	Description
No parameters.

create_annotation Write

Creates an annotation in the Grafana database. The dashboardId and panelId fields are optional. If they are not specified then an organization annotation is created and can be queried in any dashboard that adds the Grafana annotations data source. When creating a region annotation include the timeEnd property. The format for `time` and `timeEnd` should be epoch numbers in millisecond resolution...

Lua path: app.integrations.grafana.create_annotation
Full name: grafana.grafana_post_annotation

Parameter	Type	Required	Description
No parameters.

create_annotation_graphite_format Write

Creates an annotation by using Graphite-compatible event format. The `when` and `data` fields are optional. If `when` is not specified then the current time will be used as annotation's timestamp. The `tags` field can also be in prior to Graphite `0.10.0` format (string with multiple tags being separated by a space).

Lua path: app.integrations.grafana.create_annotation_graphite_format
Full name: grafana.grafana_post_graphite_annotation

Parameter	Type	Required	Description
No parameters.

delete_multiple_annotations Write

Delete multiple annotations. (POST /annotations/mass-delete).

Lua path: app.integrations.grafana.delete_multiple_annotations
Full name: grafana.grafana_mass_delete_annotations

Parameter	Type	Required	Description
No parameters.

find_annotations_tags Read

Find all the event tags created in the annotations.

Lua path: app.integrations.grafana.find_annotations_tags
Full name: grafana.grafana_get_annotation_tags

Parameter	Type	Required	Description
No parameters.

delete_annotation_by_id Write

Deletes the annotation that matches the specified ID.

Lua path: app.integrations.grafana.delete_annotation_by_id
Full name: grafana.grafana_delete_annotation_by_i_d

Parameter	Type	Required	Description
No parameters.

get_annotation_by_id Read

Get Annotation by ID. (GET /annotations/{annotation_id}).

Lua path: app.integrations.grafana.get_annotation_by_id
Full name: grafana.grafana_get_annotation_by_i_d

Parameter	Type	Required	Description
No parameters.

patch_annotation Write

Updates one or more properties of an annotation that matches the specified ID. This operation currently supports updating of the `text`, `tags`, `time` and `timeEnd` properties. This is available in Grafana 6.0.0-beta2 and above.

Lua path: app.integrations.grafana.patch_annotation
Full name: grafana.grafana_patch_annotation

Parameter	Type	Required	Description
No parameters.

update_annotation Write

Updates all properties of an annotation that matches the specified id. To only update certain property, consider using the Patch Annotation operation.

Lua path: app.integrations.grafana.update_annotation
Full name: grafana.grafana_update_annotation

Parameter	Type	Required	Description
No parameters.

lists_all_devices_within_last_30_days Read

Lists all devices within the last 30 days (GET /anonymous/devices).

Lua path: app.integrations.grafana.lists_all_devices_within_last_30_days
Full name: grafana.grafana_list_devices

Parameter	Type	Required	Description
No parameters.

lists_all_devices_within_last_30_days Read

Lists all devices within the last 30 days (GET /anonymous/search).

Lua path: app.integrations.grafana.lists_all_devices_within_last_30_days
Full name: grafana.grafana_search_devices

Parameter	Type	Required	Description
No parameters.

get_list_all_cloud_migration_sessions_that_have_been_created Read

Get a list of all cloud migration sessions that have been created. (GET /cloudmigration/migration).

Lua path: app.integrations.grafana.get_list_all_cloud_migration_sessions_that_have_been_created
Full name: grafana.grafana_get_session_list

Parameter	Type	Required	Description
No parameters.

create_migration_session Write

Create a migration session. (POST /cloudmigration/migration).

Lua path: app.integrations.grafana.create_migration_session
Full name: grafana.grafana_create_session

Parameter	Type	Required	Description
No parameters.

delete_migration_session_by_its_uid Write

Delete a migration session by its uid. (DELETE /cloudmigration/migration/{uid}).

Lua path: app.integrations.grafana.delete_migration_session_by_its_uid
Full name: grafana.grafana_delete_session

Parameter	Type	Required	Description
No parameters.

get_cloud_migration_session_by_its_uid Read

Get a cloud migration session by its uid. (GET /cloudmigration/migration/{uid}).

Lua path: app.integrations.grafana.get_cloud_migration_session_by_its_uid
Full name: grafana.grafana_get_session

Parameter	Type	Required	Description
No parameters.

trigger_creation_instance_snapshot_associated_with_provided_session Write

If the snapshot initialization is successful, the snapshot uid is returned.

Lua path: app.integrations.grafana.trigger_creation_instance_snapshot_associated_with_provided_session
Full name: grafana.grafana_create_snapshot

Parameter	Type	Required	Description
No parameters.

get_metadata_about_snapshot_including_where_it_is_its_processing_and_final_results Read

Get metadata about a snapshot, including where it is in its processing and final results. (GET /cloudmigration/migration/{uid}/snapshot/{snapshotUid}).

Lua path: app.integrations.grafana.get_metadata_about_snapshot_including_where_it_is_its_processing_and_final_results
Full name: grafana.grafana_get_snapshot

Parameter	Type	Required	Description
No parameters.

cancel_snapshot_wherever_it_is_its_processing_chain Write

TODO: Implement

Lua path: app.integrations.grafana.cancel_snapshot_wherever_it_is_its_processing_chain
Full name: grafana.grafana_cancel_snapshot

Parameter	Type	Required	Description
No parameters.

upload_snapshot_migration_service_processing Write

Upload a snapshot to the Grafana Migration Service for processing. (POST /cloudmigration/migration/{uid}/snapshot/{snapshotUid}/upload).

Lua path: app.integrations.grafana.upload_snapshot_migration_service_processing
Full name: grafana.grafana_upload_snapshot

Parameter	Type	Required	Description
No parameters.

get_list_snapshots_session Read

Get a list of snapshots for a session. (GET /cloudmigration/migration/{uid}/snapshots).

Lua path: app.integrations.grafana.get_list_snapshots_session
Full name: grafana.grafana_get_shapshot_list

Parameter	Type	Required	Description
No parameters.

get_resource_dependencies_graph_current_set_migratable_resources Read

Get the resource dependencies graph for the current set of migratable resources. (GET /cloudmigration/resources/dependencies).

Lua path: app.integrations.grafana.get_resource_dependencies_graph_current_set_migratable_resources
Full name: grafana.grafana_get_resource_dependencies

Parameter	Type	Required	Description
No parameters.

fetch_cloud_migration_token_if_it_exists Read

Fetch the cloud migration token if it exists. (GET /cloudmigration/token).

Lua path: app.integrations.grafana.fetch_cloud_migration_token_if_it_exists
Full name: grafana.grafana_get_cloud_migration_token

Parameter	Type	Required	Description
No parameters.

create_gcom_access_token Write

Create gcom access token. (POST /cloudmigration/token).

Lua path: app.integrations.grafana.create_gcom_access_token
Full name: grafana.grafana_create_cloud_migration_token

Parameter	Type	Required	Description
No parameters.

deletes_cloud_migration_token Write

Deletes a cloud migration token. (DELETE /cloudmigration/token/{uid}).

Lua path: app.integrations.grafana.deletes_cloud_migration_token
Full name: grafana.grafana_delete_cloud_migration_token

Parameter	Type	Required	Description
No parameters.

gets_all_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_group Read

Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, group... (GET /convert/api/prom/rules).

Lua path: app.integrations.grafana.gets_all_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_group
Full name: grafana.grafana_route_convert_prometheus_cortex_get_rules

Parameter	Type	Required	Description
No parameters.

converts_submitted_rule_groups_into_managed_rules Write

Converts the submitted rule groups into Grafana-Managed Rules. (POST /convert/api/prom/rules).

Lua path: app.integrations.grafana.converts_submitted_rule_groups_into_managed_rules
Full name: grafana.grafana_route_convert_prometheus_cortex_post_rule_groups

Parameter	Type	Required	Description
No parameters.

deletes_all_rule_groups_that_were_imported_from_prometheus_compatible_sources_within_specifie Write

Deletes all rule groups that were imported from Prometheus-compatible sources within the specifie... (DELETE /convert/api/prom/rules/{NamespaceTitle}).

Lua path: app.integrations.grafana.deletes_all_rule_groups_that_were_imported_from_prometheus_compatible_sources_within_specifie
Full name: grafana.grafana_route_convert_prometheus_cortex_delete_namespace

Parameter	Type	Required	Description
No parameters.

gets_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_spec Read

Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a spec... (GET /convert/api/prom/rules/{NamespaceTitle}).

Lua path: app.integrations.grafana.gets_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_spec
Full name: grafana.grafana_route_convert_prometheus_cortex_get_namespace

Parameter	Type	Required	Description
No parameters.

converts_prometheus_rule_group_into_rule_group_and_creates_or_updates_it_within Write

If the group already exists and was not imported from a Prometheus-compatible source initially, it will not be replaced and an error will be returned.

Lua path: app.integrations.grafana.converts_prometheus_rule_group_into_rule_group_and_creates_or_updates_it_within
Full name: grafana.grafana_route_convert_prometheus_cortex_post_rule_group

Parameter	Type	Required	Description
No parameters.

deletes_specific_rule_group_if_it_was_imported_from_prometheus_compatible_source Write

Deletes a specific rule group if it was imported from a Prometheus-compatible source. (DELETE /convert/api/prom/rules/{NamespaceTitle}/{Group}).

Lua path: app.integrations.grafana.deletes_specific_rule_group_if_it_was_imported_from_prometheus_compatible_source
Full name: grafana.grafana_route_convert_prometheus_cortex_delete_rule_group

Parameter	Type	Required	Description
No parameters.

gets_single_rule_group_prometheus_compatible_format_if_it_was_imported_from_prometheus_com Read

Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-com... (GET /convert/api/prom/rules/{NamespaceTitle}/{Group}).

Lua path: app.integrations.grafana.gets_single_rule_group_prometheus_compatible_format_if_it_was_imported_from_prometheus_com
Full name: grafana.grafana_route_convert_prometheus_cortex_get_rule_group

Parameter	Type	Required	Description
No parameters.

gets_all_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_group Read

Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, group... (GET /convert/prometheus/config/v1/rules).

Lua path: app.integrations.grafana.gets_all_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_group
Full name: grafana.grafana_route_convert_prometheus_get_rules

Parameter	Type	Required	Description
No parameters.

converts_submitted_rule_groups_into_managed_rules Write

Converts the submitted rule groups into Grafana-Managed Rules. (POST /convert/prometheus/config/v1/rules).

Lua path: app.integrations.grafana.converts_submitted_rule_groups_into_managed_rules
Full name: grafana.grafana_route_convert_prometheus_post_rule_groups

Parameter	Type	Required	Description
No parameters.

deletes_all_rule_groups_that_were_imported_from_prometheus_compatible_sources_within_specifie Write

Deletes all rule groups that were imported from Prometheus-compatible sources within the specifie... (DELETE /convert/prometheus/config/v1/rules/{NamespaceTitle}).

Lua path: app.integrations.grafana.deletes_all_rule_groups_that_were_imported_from_prometheus_compatible_sources_within_specifie
Full name: grafana.grafana_route_convert_prometheus_delete_namespace

Parameter	Type	Required	Description
No parameters.

gets_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_spec Read

Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a spec... (GET /convert/prometheus/config/v1/rules/{NamespaceTitle}).

Lua path: app.integrations.grafana.gets_managed_alert_rules_that_were_imported_from_prometheus_compatible_sources_spec
Full name: grafana.grafana_route_convert_prometheus_get_namespace

Parameter	Type	Required	Description
No parameters.

converts_prometheus_rule_group_into_rule_group_and_creates_or_updates_it_within Write

If the group already exists and was not imported from a Prometheus-compatible source initially, it will not be replaced and an error will be returned.

Lua path: app.integrations.grafana.converts_prometheus_rule_group_into_rule_group_and_creates_or_updates_it_within
Full name: grafana.grafana_route_convert_prometheus_post_rule_group

Parameter	Type	Required	Description
No parameters.

deletes_specific_rule_group_if_it_was_imported_from_prometheus_compatible_source Write

Deletes a specific rule group if it was imported from a Prometheus-compatible source. (DELETE /convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}).

Lua path: app.integrations.grafana.deletes_specific_rule_group_if_it_was_imported_from_prometheus_compatible_source
Full name: grafana.grafana_route_convert_prometheus_delete_rule_group

Parameter	Type	Required	Description
No parameters.

gets_single_rule_group_prometheus_compatible_format_if_it_was_imported_from_prometheus_com Read

Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-com... (GET /convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}).

Lua path: app.integrations.grafana.gets_single_rule_group_prometheus_compatible_format_if_it_was_imported_from_prometheus_com
Full name: grafana.grafana_route_convert_prometheus_get_rule_group

Parameter	Type	Required	Description
No parameters.

list_snapshots Read

List snapshots. (GET /dashboard/snapshots).

Lua path: app.integrations.grafana.list_snapshots
Full name: grafana.grafana_search_dashboard_snapshots

Parameter	Type	Required	Description
No parameters.

create_update_dashboard Write

Creates a new dashboard or updates an existing dashboard. Note: This endpoint is not intended for creating folders, use `POST /api/folders` for that. Use: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards

Lua path: app.integrations.grafana.create_update_dashboard
Full name: grafana.grafana_create_dashboard

Parameter	Type	Required	Description
No parameters.

gethomedashboard Read

NOTE: the home dashboard is configured in preferences. This API will be removed in G13

Lua path: app.integrations.grafana.gethomedashboard
Full name: grafana.grafana_get_home_dashboard

Parameter	Type	Required	Description
No parameters.

import_dashboard Write

Import dashboard. (POST /dashboards/import).

Lua path: app.integrations.grafana.import_dashboard
Full name: grafana.grafana_import_dashboard

Parameter	Type	Required	Description
No parameters.

interpolate_dashboard_this_is_experimental_endpoint_under_dashboardlibrary_or_suggesteddashbo Write

Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashbo... (POST /dashboards/interpolate).

Lua path: app.integrations.grafana.interpolate_dashboard_this_is_experimental_endpoint_under_dashboardlibrary_or_suggesteddashbo
Full name: grafana.grafana_interpolate_dashboard

Parameter	Type	Required	Description
No parameters.

listpublicdashboards Read

Get list of public dashboards

Lua path: app.integrations.grafana.listpublicdashboards
Full name: grafana.grafana_list_public_dashboards

Parameter	Type	Required	Description
No parameters.

get_all_dashboards_tags_organization Read

Get all dashboards tags of an organization. (GET /dashboards/tags).

Lua path: app.integrations.grafana.get_all_dashboards_tags_organization
Full name: grafana.grafana_get_dashboard_tags

Parameter	Type	Required	Description
No parameters.

getpublicdashboard Read

Get public dashboard by dashboardUid

Lua path: app.integrations.grafana.getpublicdashboard
Full name: grafana.grafana_get_public_dashboard

Parameter	Type	Required	Description
No parameters.

createpublicdashboard Write

Create public dashboard for a dashboard

Lua path: app.integrations.grafana.createpublicdashboard
Full name: grafana.grafana_create_public_dashboard

Parameter	Type	Required	Description
No parameters.

deletepublicdashboard Write

Delete public dashboard for a dashboard

Lua path: app.integrations.grafana.deletepublicdashboard
Full name: grafana.grafana_delete_public_dashboard

Parameter	Type	Required	Description
No parameters.

updatepublicdashboard Write

Update public dashboard for a dashboard

Lua path: app.integrations.grafana.updatepublicdashboard
Full name: grafana.grafana_update_public_dashboard

Parameter	Type	Required	Description
No parameters.

delete_dashboard_by_uid Write

Will delete the dashboard given the specified unique identifier (uid). Use: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}

Lua path: app.integrations.grafana.delete_dashboard_by_uid
Full name: grafana.grafana_delete_dashboard_by_u_i_d

Parameter	Type	Required	Description
No parameters.

get_dashboard_by_uid Read

Optional query parameter `apiVersion` selects the Kubernetes API version used to load the dashboard first (for example `v1beta1`). If that request fails, the default version is used instead. When omitted, only the default is used. Will return the dashboard given the dashboard unique identifier (uid). Use: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}

Lua path: app.integrations.grafana.get_dashboard_by_uid
Full name: grafana.grafana_get_dashboard

Parameter	Type	Required	Description
No parameters.

gets_all_existing_permissions_given_dashboard Read

Use: /apis/dashboards.grafana.app/v1/namespaces/{ns}/dashboards/{uid}/access

Lua path: app.integrations.grafana.gets_all_existing_permissions_given_dashboard
Full name: grafana.grafana_get_dashboard_permissions_list_by_u_i_d

Parameter	Type	Required	Description
No parameters.

updates_permissions_dashboard Write

This operation will remove existing permissions if they're not included in the request.

Lua path: app.integrations.grafana.updates_permissions_dashboard
Full name: grafana.grafana_update_dashboard_permissions_by_u_i_d

Parameter	Type	Required	Description
No parameters.

restore_dashboard_given_dashboard_version_using_uid Write

This API will be removed when /apis/dashboards.grafana.app/v1 is released. You can restore a dashboard by reading it from history, then creating it again.

Lua path: app.integrations.grafana.restore_dashboard_given_dashboard_version_using_uid
Full name: grafana.grafana_restore_dashboard_version_by_u_i_d

Parameter	Type	Required	Description
No parameters.

gets_all_existing_versions_dashboard_using_uid Read

Gets all existing versions for the dashboard using UID. (GET /dashboards/uid/{uid}/versions).

Lua path: app.integrations.grafana.gets_all_existing_versions_dashboard_using_uid
Full name: grafana.grafana_get_dashboard_versions_by_u_i_d

Parameter	Type	Required	Description
No parameters.

get_specific_dashboard_version_using_uid Read

Get a specific dashboard version using UID. (GET /dashboards/uid/{uid}/versions/{DashboardVersionID}).

Lua path: app.integrations.grafana.get_specific_dashboard_version_using_uid
Full name: grafana.grafana_get_dashboard_version_by_u_i_d

Parameter	Type	Required	Description
No parameters.

get_all_data_sources Read

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:read` and scope: `datasources:*`.

Lua path: app.integrations.grafana.get_all_data_sources
Full name: grafana.grafana_list_datasources

Parameter	Type	Required	Description
No parameters.

create_data_source Write

By defining `password` and `basicAuthPassword` under secureJsonData property Grafana encrypts them securely as an encrypted blob in the database. The response then lists the encrypted fields under secureJsonFields. If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:create`

Lua path: app.integrations.grafana.create_data_source
Full name: grafana.grafana_add_data_source

Parameter	Type	Required	Description
No parameters.

gets_all_correlations Read

Gets all correlations. (GET /datasources/correlations).

Lua path: app.integrations.grafana.gets_all_correlations
Full name: grafana.grafana_get_correlations

Parameter	Type	Required	Description
No parameters.

get_data_source_id_by_name_this_function_will_be_removed_future Read

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).

Lua path: app.integrations.grafana.get_data_source_id_by_name_this_function_will_be_removed_future
Full name: grafana.grafana_get_data_source_id_by_name

Parameter	Type	Required	Description
No parameters.

delete_existing_data_source_by_name_this_function_will_be_removed_future Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:name:*` and `datasources:name:test_datasource` (single data source).

Lua path: app.integrations.grafana.delete_existing_data_source_by_name_this_function_will_be_removed_future
Full name: grafana.grafana_delete_data_source_by_name

Parameter	Type	Required	Description
No parameters.

get_single_data_source_by_name_this_function_will_be_removed_future Read

Lua path: app.integrations.grafana.get_single_data_source_by_name_this_function_will_be_removed_future
Full name: grafana.grafana_get_data_source_by_name

Parameter	Type	Required	Description
No parameters.

data_source_proxy_delete_calls Write

Proxies all calls to the actual data source.

Lua path: app.integrations.grafana.data_source_proxy_delete_calls
Full name: grafana.grafana_datasource_proxy_d_e_l_e_t_e_by_u_i_dcalls

Parameter	Type	Required	Description
No parameters.

data_source_proxy_get_calls Read

Proxies all calls to the actual data source.

Lua path: app.integrations.grafana.data_source_proxy_get_calls
Full name: grafana.grafana_datasource_proxy_g_e_t_by_u_i_dcalls

Parameter	Type	Required	Description
No parameters.

data_source_proxy_post_calls Write

Proxies all calls to the actual data source. The data source should support POST methods for the specific path and role as defined

Lua path: app.integrations.grafana.data_source_proxy_post_calls
Full name: grafana.grafana_datasource_proxy_p_o_s_t_by_u_i_dcalls

Parameter	Type	Required	Description
No parameters.

gets_all_correlations_originating_from_given_data_source Read

Gets all correlations originating from the given data source. (GET /datasources/uid/{sourceUID}/correlations).

Lua path: app.integrations.grafana.gets_all_correlations_originating_from_given_data_source
Full name: grafana.grafana_get_correlations_by_source_u_i_d

Parameter	Type	Required	Description
No parameters.

add_correlation Write

Add correlation. (POST /datasources/uid/{sourceUID}/correlations).

Lua path: app.integrations.grafana.add_correlation
Full name: grafana.grafana_create_correlation

Parameter	Type	Required	Description
No parameters.

gets_correlation Read

Gets a correlation. (GET /datasources/uid/{sourceUID}/correlations/{correlationUID}).

Lua path: app.integrations.grafana.gets_correlation
Full name: grafana.grafana_get_correlation

Parameter	Type	Required	Description
No parameters.

updates_correlation Write

Updates a correlation. (PATCH /datasources/uid/{sourceUID}/correlations/{correlationUID}).

Lua path: app.integrations.grafana.updates_correlation
Full name: grafana.grafana_update_correlation

Parameter	Type	Required	Description
No parameters.

delete_existing_data_source_by_uid Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:kLtEtcRGk` (single data source).

Lua path: app.integrations.grafana.delete_existing_data_source_by_uid
Full name: grafana.grafana_delete_data_source_by_u_i_d

Parameter	Type	Required	Description
No parameters.

get_single_data_source_by_uid Read

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:kLtEtcRGk` (single data source).

Lua path: app.integrations.grafana.get_single_data_source_by_uid
Full name: grafana.grafana_get_data_source_by_u_i_d

Parameter	Type	Required	Description
No parameters.

update_existing_data_source Write

Similar to creating a data source, `password` and `basicAuthPassword` should be defined under secureJsonData in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under secureJsonFields section in the response. If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `dataso...

Lua path: app.integrations.grafana.update_existing_data_source
Full name: grafana.grafana_update_data_source_by_u_i_d

Parameter	Type	Required	Description
No parameters.

delete_correlation Write

Delete a correlation. (DELETE /datasources/uid/{uid}/correlations/{correlationUID}).

Lua path: app.integrations.grafana.delete_correlation
Full name: grafana.grafana_delete_correlation

Parameter	Type	Required	Description
No parameters.

sends_health_check_request_plugin_datasource_identified_by_uid Read

Sends a health check request to the plugin datasource identified by the UID. (GET /datasources/uid/{uid}/health).

Lua path: app.integrations.grafana.sends_health_check_request_plugin_datasource_identified_by_uid
Full name: grafana.grafana_check_datasource_health_with_u_i_d

Parameter	Type	Required	Description
No parameters.

retrieves_lbac_rules_team Read

Retrieves LBAC rules for a team. (GET /datasources/uid/{uid}/lbac/teams).

Lua path: app.integrations.grafana.retrieves_lbac_rules_team
Full name: grafana.grafana_get_team_l_b_a_c_rules_api

Parameter	Type	Required	Description
No parameters.

updates_lbac_rules_team Write

Updates LBAC rules for a team. (PUT /datasources/uid/{uid}/lbac/teams).

Lua path: app.integrations.grafana.updates_lbac_rules_team
Full name: grafana.grafana_update_team_l_b_a_c_rules_api

Parameter	Type	Required	Description
No parameters.

fetch_data_source_resources Read

Fetch data source resources. (GET /datasources/uid/{uid}/resources/{datasource_proxy_route}).

Lua path: app.integrations.grafana.fetch_data_source_resources
Full name: grafana.grafana_call_datasource_resource_with_u_i_d

Parameter	Type	Required	Description
No parameters.

getdatasourcecacheconfig Read

get cache config for a single data source

Lua path: app.integrations.grafana.getdatasourcecacheconfig
Full name: grafana.grafana_get_data_source_cache_config

Parameter	Type	Required	Description
No parameters.

setdatasourcecacheconfig Write

set cache config for a single data source

Lua path: app.integrations.grafana.setdatasourcecacheconfig
Full name: grafana.grafana_set_data_source_cache_config

Parameter	Type	Required	Description
No parameters.

cleandatasourcecache Write

clean cache for a single data source

Lua path: app.integrations.grafana.cleandatasourcecache
Full name: grafana.grafana_clean_data_source_cache

Parameter	Type	Required	Description
No parameters.

disabledatasourcecache Write

disable cache for a single data source

Lua path: app.integrations.grafana.disabledatasourcecache
Full name: grafana.grafana_disable_data_source_cache

Parameter	Type	Required	Description
No parameters.

enabledatasourcecache Write

enable cache for a single data source

Lua path: app.integrations.grafana.enabledatasourcecache
Full name: grafana.grafana_enable_data_source_cache

Parameter	Type	Required	Description
No parameters.

datasource_query_metrics_with_expressions Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `datasources:query`.

Lua path: app.integrations.grafana.datasource_query_metrics_with_expressions
Full name: grafana.grafana_query_metrics_with_expressions

Parameter	Type	Required	Description
No parameters.

get_all_folders Read

It returns all folders that the authenticated user has permission to view. If nested folders are enabled, it expects an additional query parameter with the parent folder UID and returns the immediate subfolders that the authenticated user has permission to view. If the parameter is not supplied then it returns immediate subfolders under the root that the authenticated user has permission to vie...

Lua path: app.integrations.grafana.get_all_folders
Full name: grafana.grafana_get_folders

Parameter	Type	Required	Description
No parameters.

create_folder Write

If nested folders are enabled then it additionally expects the parent folder UID. Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

Lua path: app.integrations.grafana.create_folder
Full name: grafana.grafana_create_folder

Parameter	Type	Required	Description
No parameters.

delete_folder Write

Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted. If nested folders are enabled then it also deletes all the subfolders. Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

Lua path: app.integrations.grafana.delete_folder
Full name: grafana.grafana_delete_folder

Parameter	Type	Required	Description
No parameters.

get_folder_by_uid Read

Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

Lua path: app.integrations.grafana.get_folder_by_uid
Full name: grafana.grafana_get_folder_by_u_i_d

Parameter	Type	Required	Description
No parameters.

update_folder Write

Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

Lua path: app.integrations.grafana.update_folder
Full name: grafana.grafana_update_folder

Parameter	Type	Required	Description
No parameters.

gets_count_each_descendant_folder_by_kind_folder_is_identified_by_uid Read

Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

Lua path: app.integrations.grafana.gets_count_each_descendant_folder_by_kind_folder_is_identified_by_uid
Full name: grafana.grafana_get_folder_descendant_counts

Parameter	Type	Required	Description
No parameters.

move_folder Write

Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}, Changing the parent folder annotation

Lua path: app.integrations.grafana.move_folder
Full name: grafana.grafana_move_folder

Parameter	Type	Required	Description
No parameters.

gets_all_existing_permissions_folder_with_given_uid Read

Gets all existing permissions for the folder with the given `uid`. (GET /folders/{folder_uid}/permissions).

Lua path: app.integrations.grafana.gets_all_existing_permissions_folder_with_given_uid
Full name: grafana.grafana_get_folder_permission_list

Parameter	Type	Required	Description
No parameters.

updates_permissions_folder_this_operation_will_remove_existing_permissions_if_they_re_not Write

Updates permissions for a folder. This operation will remove existing permissions if they're not... (POST /folders/{folder_uid}/permissions).

Lua path: app.integrations.grafana.updates_permissions_folder_this_operation_will_remove_existing_permissions_if_they_re_not
Full name: grafana.grafana_update_folder_permissions

Parameter	Type	Required	Description
No parameters.

list_groups_that_have_mappings_set_this_endpoint_is_behind_feature_flag_groupattributesync Read

List groups that have mappings set. This endpoint is behind the feature flag `groupAttributeSync`... (GET /groupsync/groups).

Lua path: app.integrations.grafana.list_groups_that_have_mappings_set_this_endpoint_is_behind_feature_flag_groupattributesync
Full name: grafana.grafana_get_mapped_groups

Parameter	Type	Required	Description
No parameters.

delete_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is Write

Delete mappings for a group. This endpoint is behind the feature flag `groupAttributeSync` and is... (DELETE /groupsync/groups/{group_id}).

Lua path: app.integrations.grafana.delete_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is
Full name: grafana.grafana_delete_group_mappings

Parameter	Type	Required	Description
No parameters.

create_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is Write

Create mappings for a group. This endpoint is behind the feature flag `groupAttributeSync` and is... (POST /groupsync/groups/{group_id}).

Lua path: app.integrations.grafana.create_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is
Full name: grafana.grafana_create_group_mappings

Parameter	Type	Required	Description
No parameters.

update_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is Write

Update mappings for a group. This endpoint is behind the feature flag `groupAttributeSync` and is... (PUT /groupsync/groups/{group_id}).

Lua path: app.integrations.grafana.update_mappings_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is
Full name: grafana.grafana_update_group_mappings

Parameter	Type	Required	Description
No parameters.

get_roles_mapped_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is Read

Get roles mapped to a group. This endpoint is behind the feature flag `groupAttributeSync` and is... (GET /groupsync/groups/{group_id}/roles).

Lua path: app.integrations.grafana.get_roles_mapped_group_this_endpoint_is_behind_feature_flag_groupattributesync_and_is
Full name: grafana.grafana_get_group_roles

Parameter	Type	Required	Description
No parameters.

gethealth Read

apiHealthHandler will return ok if Grafana's web server is running and it can access the database. If the database cannot be accessed it will return http status code 503.

Lua path: app.integrations.grafana.gethealth
Full name: grafana.grafana_get_health

Parameter	Type	Required	Description
No parameters.

get_all_library_elements Read

Returns a list of all library elements the authenticated user has permission to view. Use the `perPage` query parameter to control the maximum number of library elements returned; the default limit is `100`. You can also use the `page` query parameter to fetch library elements from any page other than the first one.

Lua path: app.integrations.grafana.get_all_library_elements
Full name: grafana.grafana_get_library_elements

Parameter	Type	Required	Description
No parameters.

create_library_element Write

Creates a new library element.

Lua path: app.integrations.grafana.create_library_element
Full name: grafana.grafana_create_library_element

Parameter	Type	Required	Description
No parameters.

get_library_element_by_name Read

Returns a library element with the given name.

Lua path: app.integrations.grafana.get_library_element_by_name
Full name: grafana.grafana_get_library_element_by_name

Parameter	Type	Required	Description
No parameters.

delete_library_element Write

Deletes an existing library element as specified by the UID. This operation cannot be reverted. You cannot delete a library element that is connected. This operation cannot be reverted.

Lua path: app.integrations.grafana.delete_library_element
Full name: grafana.grafana_delete_library_element_by_u_i_d

Parameter	Type	Required	Description
No parameters.

get_library_element_by_uid Read

Returns a library element with the given UID.

Lua path: app.integrations.grafana.get_library_element_by_uid
Full name: grafana.grafana_get_library_element_by_u_i_d

Parameter	Type	Required	Description
No parameters.

update_library_element Write

Updates an existing library element identified by uid.

Lua path: app.integrations.grafana.update_library_element
Full name: grafana.grafana_update_library_element

Parameter	Type	Required	Description
No parameters.

get_library_element_connections Read

Returns a list of connections for a library element based on the UID specified.

Lua path: app.integrations.grafana.get_library_element_connections
Full name: grafana.grafana_get_library_element_connections

Parameter	Type	Required	Description
No parameters.

check_license_availability Read

Check license availability. (GET /licensing/check).

Lua path: app.integrations.grafana.check_license_availability
Full name: grafana.grafana_get_status

Parameter	Type	Required	Description
No parameters.

get_custom_permissions_report Read

You need to have a permission with action `licensing.reports:read`.

Lua path: app.integrations.grafana.get_custom_permissions_report
Full name: grafana.grafana_get_custom_permissions_report

Parameter	Type	Required	Description
No parameters.

get_custom_permissions_report_csv_format Read

You need to have a permission with action `licensing.reports:read`.

Lua path: app.integrations.grafana.get_custom_permissions_report_csv_format
Full name: grafana.grafana_get_custom_permissions_c_s_v

Parameter	Type	Required	Description
No parameters.

refresh_license_stats Read

You need to have a permission with action `licensing:read`.

Lua path: app.integrations.grafana.refresh_license_stats
Full name: grafana.grafana_refresh_license_stats

Parameter	Type	Required	Description
No parameters.

remove_license_from_database Write

Removes the license stored in the Grafana database. Available in Grafana Enterprise v7.4+. You need to have a permission with action `licensing:delete`.

Lua path: app.integrations.grafana.remove_license_from_database
Full name: grafana.grafana_delete_license_token

Parameter	Type	Required	Description
No parameters.

get_license_token Read

You need to have a permission with action `licensing:read`.

Lua path: app.integrations.grafana.get_license_token
Full name: grafana.grafana_get_license_token

Parameter	Type	Required	Description
No parameters.

create_license_token Write

You need to have a permission with action `licensing:write`.

Lua path: app.integrations.grafana.create_license_token
Full name: grafana.grafana_post_license_token

Parameter	Type	Required	Description
No parameters.

manually_force_license_refresh Write

Manually ask license issuer for a new token. Available in Grafana Enterprise v7.4+. You need to have a permission with action `licensing:write`.

Lua path: app.integrations.grafana.manually_force_license_refresh
Full name: grafana.grafana_post_renew_license_token

Parameter	Type	Required	Description
No parameters.

getlogout_initiates_single_logout_process Read

GetLogout initiates single logout process. (GET /logout/saml).

Lua path: app.integrations.grafana.getlogout_initiates_single_logout_process
Full name: grafana.grafana_get_s_a_m_l_logout

Parameter	Type	Required	Description
No parameters.

get_current_organization Read

Get current Organization. (GET /org).

Lua path: app.integrations.grafana.get_current_organization
Full name: grafana.grafana_get_current_org

Parameter	Type	Required	Description
No parameters.

update_current_organization Write

Update current Organization. (PUT /org).

Lua path: app.integrations.grafana.update_current_organization
Full name: grafana.grafana_update_current_org

Parameter	Type	Required	Description
No parameters.

update_current_organization_address Write

Update current Organization's address. (PUT /org/address).

Lua path: app.integrations.grafana.update_current_organization_address
Full name: grafana.grafana_update_current_org_address

Parameter	Type	Required	Description
No parameters.

get_pending_invites Read

Get pending invites. (GET /org/invites).

Lua path: app.integrations.grafana.get_pending_invites
Full name: grafana.grafana_get_pending_org_invites

Parameter	Type	Required	Description
No parameters.

add_invite Write

Add invite. (POST /org/invites).

Lua path: app.integrations.grafana.add_invite
Full name: grafana.grafana_add_org_invite

Parameter	Type	Required	Description
No parameters.

revoke_invite Write

Revoke invite. (DELETE /org/invites/{invitation_code}/revoke).

Lua path: app.integrations.grafana.revoke_invite
Full name: grafana.grafana_revoke_invite

Parameter	Type	Required	Description
No parameters.

get_current_org_prefs Read

Get Current Org Prefs. (GET /org/preferences).

Lua path: app.integrations.grafana.get_current_org_prefs
Full name: grafana.grafana_get_org_preferences

Parameter	Type	Required	Description
No parameters.

patch_current_org_prefs Write

Patch Current Org Prefs. (PATCH /org/preferences).

Lua path: app.integrations.grafana.patch_current_org_prefs
Full name: grafana.grafana_patch_org_preferences

Parameter	Type	Required	Description
No parameters.

update_current_org_prefs Write

Update Current Org Prefs. (PUT /org/preferences).

Lua path: app.integrations.grafana.update_current_org_prefs
Full name: grafana.grafana_update_org_preferences

Parameter	Type	Required	Description
No parameters.

fetch_organization_quota Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).

Lua path: app.integrations.grafana.fetch_organization_quota
Full name: grafana.grafana_get_current_org_quota

Parameter	Type	Required	Description
No parameters.

get_all_users_within_current_organization Read

Returns all org users within the current organization. Accessible to users with org admin role. If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:read` with scope `users:*`.

Lua path: app.integrations.grafana.get_all_users_within_current_organization
Full name: grafana.grafana_get_org_users_for_current_org

Parameter	Type	Required	Description
No parameters.

add_new_user_current_organization Write

Adds a global user to the current organization. If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:add` with scope `users:*`.

Lua path: app.integrations.grafana.add_new_user_current_organization
Full name: grafana.grafana_add_org_user_to_current_org

Parameter	Type	Required	Description
No parameters.

get_all_users_within_current_organization_lookup Read

Returns all org users within the current organization, but with less detailed information. Accessible to users with org admin role, admin in any folder or admin of any team. Mainly used by Grafana UI for providing list of users when adding team members and when editing folder/dashboard permissions.

Lua path: app.integrations.grafana.get_all_users_within_current_organization_lookup
Full name: grafana.grafana_get_org_users_for_current_org_lookup

Parameter	Type	Required	Description
No parameters.

delete_user_current_organization Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:remove` with scope `users:*`.

Lua path: app.integrations.grafana.delete_user_current_organization
Full name: grafana.grafana_remove_org_user_for_current_org

Parameter	Type	Required	Description
No parameters.

updates_given_user Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users.role:update` with scope `users:*`.

Lua path: app.integrations.grafana.updates_given_user
Full name: grafana.grafana_update_org_user_for_current_org

Parameter	Type	Required	Description
No parameters.

search_all_organizations Read

Search all Organizations. (GET /orgs).

Lua path: app.integrations.grafana.search_all_organizations
Full name: grafana.grafana_search_orgs

Parameter	Type	Required	Description
No parameters.

create_organization Write

Only works if [users.allow_org_create](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_org_create) is set.

Lua path: app.integrations.grafana.create_organization
Full name: grafana.grafana_create_org

Parameter	Type	Required	Description
No parameters.

get_organization_by_name Read

Get Organization by Name. (GET /orgs/name/{org_name}).

Lua path: app.integrations.grafana.get_organization_by_name
Full name: grafana.grafana_get_org_by_name

Parameter	Type	Required	Description
No parameters.

delete_organization Write

Delete Organization. (DELETE /orgs/{org_id}).

Lua path: app.integrations.grafana.delete_organization
Full name: grafana.grafana_delete_org_by_i_d

Parameter	Type	Required	Description
No parameters.

get_organization_by_id Read

Get Organization by ID. (GET /orgs/{org_id}).

Lua path: app.integrations.grafana.get_organization_by_id
Full name: grafana.grafana_get_org_by_i_d

Parameter	Type	Required	Description
No parameters.

update_organization Write

Update Organization. (PUT /orgs/{org_id}).

Lua path: app.integrations.grafana.update_organization
Full name: grafana.grafana_update_org

Parameter	Type	Required	Description
No parameters.

update_organization_address Write

Update Organization's address. (PUT /orgs/{org_id}/address).

Lua path: app.integrations.grafana.update_organization_address
Full name: grafana.grafana_update_org_address

Parameter	Type	Required	Description
No parameters.

fetch_organization_quota Read

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:read` and scope `org:id:1` (orgIDScope).

Lua path: app.integrations.grafana.fetch_organization_quota
Full name: grafana.grafana_get_org_quota

Parameter	Type	Required	Description
No parameters.

update_user_quota Write

If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `orgs.quotas:write` and scope `org:id:1` (orgIDScope).

Lua path: app.integrations.grafana.update_user_quota
Full name: grafana.grafana_update_org_quota

Parameter	Type	Required	Description
No parameters.

get_users_organization Read

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:read` with scope `users:*`.

Lua path: app.integrations.grafana.get_users_organization
Full name: grafana.grafana_get_org_users

Parameter	Type	Required	Description
No parameters.

add_new_user_current_organization Write

Lua path: app.integrations.grafana.add_new_user_current_organization
Full name: grafana.grafana_add_org_user

Parameter	Type	Required	Description
No parameters.

search_users_organization Read

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:read` with scope `users:*`.

Lua path: app.integrations.grafana.search_users_organization
Full name: grafana.grafana_search_org_users

Parameter	Type	Required	Description
No parameters.

delete_user_current_organization Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users:remove` with scope `users:*`.

Lua path: app.integrations.grafana.delete_user_current_organization
Full name: grafana.grafana_remove_org_user

Parameter	Type	Required	Description
No parameters.

update_users_organization Write

If you are running Grafana Enterprise and have Fine-grained access control enabled you need to have a permission with action: `org.users.role:update` with scope `users:*`.

Lua path: app.integrations.grafana.update_users_organization
Full name: grafana.grafana_update_org_user

Parameter	Type	Required	Description
No parameters.

get_playlists Read