Open Connector
All tools

Grafana logoGrafana

No catalog description yet.

grafanavcatalog-v1312 tools

Authentication

MethodKindStatusDetails
API Keyapi_keyavailable

Call a tool

import { createClient } from "@open-connector/sdk";const oc = createClient({  baseUrl: "https://api.openconnector.dev",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({  slug: "GRAFANA_ADD_DATA_SOURCE",  connectedAccountId: "conn_...",  arguments: { /* match this tool's input schema */ },});
import Composio from "@composio/client";const composio = new Composio({  baseURL: "https://api.openconnector.dev/composio",  apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("GRAFANA_ADD_DATA_SOURCE", {  connected_account_id: "conn_...",  arguments: { /* match this tool's input schema */ },});
oc tools execute GRAFANA_ADD_DATA_SOURCE --data '{ }'

Tool catalog

Available tools

312 callable operations

Create a data source.GRAFANA_ADD_DATA_SOURCEBy 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`

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`

Authentication

Connected account required

Tags

datasources
Add invite.GRAFANA_ADD_ORG_INVITEAdd invite.

Add invite.

Authentication

Connected account required

Tags

orginvites
Add a new user to the current organization.GRAFANA_ADD_ORG_USERAdds 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:*`.

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:*`.

Authentication

Connected account required

Tags

orgs
Add a new user to the current organization.GRAFANA_ADD_ORG_USER_TO_CURRENT_ORGAdds 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:*`.

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:*`.

Authentication

Connected account required

Tags

org
Add External Group.GRAFANA_ADD_TEAM_GROUP_APIAdd External Group.

Add External Group.

Authentication

Connected account required

Tags

sync_team_groupsenterprise
Add Team Member.GRAFANA_ADD_TEAM_MEMBERAdd Team Member.

Add Team Member.

Authentication

Connected account required

Tags

teams
Add team role.GRAFANA_ADD_TEAM_ROLEYou need to have a permission with action `teams.roles:add` and scope `permissions:type:delegate`.

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

Authentication

Connected account required

Tags

access_controlenterprise
Add a user role assignment.GRAFANA_ADD_USER_ROLEAssign 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 users, they won’t be able to assign a role which will allow to do that. This is done to prevent escalation of privileges.

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 users, they won’t be able to assign a role which will allow to do that. This is done to prevent escalation of privileges.

Authentication

Connected account required

Tags

access_controlenterprise
Create new user.GRAFANA_ADMIN_CREATE_USERIf 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`.

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`.

Authentication

Connected account required

Tags

admin_users
Delete global User.GRAFANA_ADMIN_DELETE_USERIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

admin_users
Disable user.GRAFANA_ADMIN_DISABLE_USERIf 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).

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).

Authentication

Connected account required

Tags

admin_users
Enable user.GRAFANA_ADMIN_ENABLE_USERIf 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).

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).

Authentication

Connected account required

Tags

admin_users
Fetch settings.GRAFANA_ADMIN_GET_SETTINGSIf 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).

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).

Authentication

Connected account required

Tags

admin
Fetch Grafana Stats.GRAFANA_ADMIN_GET_STATSOnly 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`.

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`.

Authentication

Connected account required

Tags

admin
Return a list of all auth tokens (devices) that the user currently have logged in from.GRAFANA_ADMIN_GET_USER_AUTH_TOKENSIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

admin_users
Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.GRAFANA_ADMIN_LOGOUT_USERIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

admin_users
You need to have a permission with action `provisioning:reload` with scope `provisioners:accesscontrol`.GRAFANA_ADMIN_PROVISIONING_RELOAD_ACCESS_CONTROLYou need to have a permission with action `provisioning:reload` with scope `provisioners:accesscontrol`.

You need to have a permission with action `provisioning:reload` with scope `provisioners:accesscontrol`.

Authentication

Connected account required

Tags

admin_provisioningaccess_controlenterprise
Reload dashboard provisioning configurations.GRAFANA_ADMIN_PROVISIONING_RELOAD_DASHBOARDSReloads 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 with action `provisioning:reload` and scope `provisioners:dashboards`.

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 with action `provisioning:reload` and scope `provisioners:dashboards`.

Authentication

Connected account required

Tags

admin_provisioning
Reload datasource provisioning configurations.GRAFANA_ADMIN_PROVISIONING_RELOAD_DATASOURCESReloads 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 with action `provisioning:reload` and scope `provisioners:datasources`.

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 with action `provisioning:reload` and scope `provisioners:datasources`.

Authentication

Connected account required

Tags

admin_provisioning
Reload plugin provisioning configurations.GRAFANA_ADMIN_PROVISIONING_RELOAD_PLUGINSReloads 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 with action `provisioning:reload` and scope `provisioners:plugin`.

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 with action `provisioning:reload` and scope `provisioners:plugin`.

Authentication

Connected account required

Tags

admin_provisioning
Revoke auth token for user.GRAFANA_ADMIN_REVOKE_USER_AUTH_TOKENRevokes 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:*`.

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:*`.

Authentication

Connected account required

Tags

admin_users
Set password for user.GRAFANA_ADMIN_UPDATE_USER_PASSWORDIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

admin_users
Set permissions for user.GRAFANA_ADMIN_UPDATE_USER_PERMISSIONSOnly 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 `users.permissions:update` and scope `global.users:*`.

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 `users.permissions:update` and scope `global.users:*`.

Authentication

Connected account required

Tags

admin_users
Fetch data source resources.GRAFANA_CALL_DATASOURCE_RESOURCE_WITH_UIDFetch data source resources.

Fetch data source resources.

Authentication

Connected account required

Tags

datasources
Cancel a snapshot, wherever it is in its processing chain.GRAFANA_CANCEL_SNAPSHOTTODO: Implement

TODO: Implement

Authentication

Connected account required

Tags

migrations
Change Password.GRAFANA_CHANGE_USER_PASSWORDChanges the password for the user.

Changes the password for the user.

Authentication

Connected account required

Tags

signed_in_user
Sends a health check request to the plugin datasource identified by the UID.GRAFANA_CHECK_DATASOURCE_HEALTH_WITH_UIDSends a health check request to the plugin datasource identified by the UID.

Sends a health check request to the plugin datasource identified by the UID.

Authentication

Connected account required

Tags

datasourceshealth
CleanDataSourceCacheGRAFANA_CLEAN_DATA_SOURCE_CACHEclean cache for a single data source

clean cache for a single data source

Authentication

Connected account required

Tags

enterprise
Create gcom access token.GRAFANA_CREATE_CLOUD_MIGRATION_TOKENCreate gcom access token.

Create gcom access token.

Authentication

Connected account required

Tags

migrations
Add correlation.GRAFANA_CREATE_CORRELATIONAdd correlation.

Add correlation.

Authentication

Connected account required

Tags

datasourcescorrelations
When creating a snapshot using the API, you have to provide the full dashboard payload including the snapshot data. This endpoint is designed for the Grafana UI.GRAFANA_CREATE_DASHBOARD_SNAPSHOTSnapshot public mode should be enabled or authentication is required.

Snapshot public mode should be enabled or authentication is required.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

folders
Create library element.GRAFANA_CREATE_LIBRARY_ELEMENTCreates a new library element.

Creates a new library element.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

orgs
Create playlist.GRAFANA_CREATE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).

Please refer to [new API](?api=playlist.grafana.app-v1).

Authentication

Connected account required

Tags

playlists
CreatePublicDashboardGRAFANA_CREATE_PUBLIC_DASHBOARDCreate public dashboard for a dashboard

Create public dashboard for a dashboard

Authentication

Connected account required

Tags

dashboardsdashboard_public
Add query to query history.GRAFANA_CREATE_QUERYAdds new query to query history.

Adds new query to query history.

Authentication

Connected account required

Tags

query_history
Create a recording rule that is then registered and started.GRAFANA_CREATE_RECORDING_RULECreate a recording rule that is then registered and started.

Create a recording rule that is then registered and started.

Authentication

Connected account required

Tags

recording_rulesenterprise
Create a remote write target.GRAFANA_CREATE_RECORDING_RULE_WRITE_TARGETIt returns a 422 if there is not an existing prometheus data source configured.

It returns a 422 if there is not an existing prometheus data source configured.

Authentication

Connected account required

Tags

recording_rulesenterprise
Create a report.GRAFANA_CREATE_REPORTAvailable to org admins only and with a valid license. You need to have a permission with action `reports.admin:create`.

Available to org admins only and with a valid license. You need to have a permission with action `reports.admin:create`.

Authentication

Connected account required

Tags

reportsenterprise
Create a new custom role.GRAFANA_CREATE_ROLECreates 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 user does not have required permissions for creating users, they won’t be able to create a custom role which allows to do that. This is done to prevent escalation of privileges.

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 user does not have required permissions for creating users, they won’t be able to create a custom role which allows to do that. This is done to prevent escalation of privileges.

Authentication

Connected account required

Tags

access_controlenterprise
Create service accountGRAFANA_CREATE_SERVICE_ACCOUNTRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:*` Requires basic authentication and that the authenticated user is a Grafana Admin.

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:*` Requires basic authentication and that the authenticated user is a Grafana Admin.

Authentication

Connected account required

Tags

service_accounts
Create a migration session.GRAFANA_CREATE_SESSIONCreate a migration session.

Create a migration session.

Authentication

Connected account required

Tags

migrations
Trigger the creation of an instance snapshot associated with the provided session.GRAFANA_CREATE_SNAPSHOTIf the snapshot initialization is successful, the snapshot uid is returned.

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

Authentication

Connected account required

Tags

migrations
Add Team.GRAFANA_CREATE_TEAMAdd Team.

Add Team.

Authentication

Connected account required

Tags

teams
CreateNewToken adds a token to a service accountGRAFANA_CREATE_TOKENRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account)

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account)

Authentication

Connected account required

Tags

service_accounts
Data source proxy DELETE calls.GRAFANA_DATASOURCE_PROXY_DELETEBY_UIDCALLSProxies all calls to the actual data source.

Proxies all calls to the actual data source.

Authentication

Connected account required

Tags

datasources
Data source proxy GET calls.GRAFANA_DATASOURCE_PROXY_GETBY_UIDCALLSProxies all calls to the actual data source.

Proxies all calls to the actual data source.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

datasources
Delete Annotation By ID.GRAFANA_DELETE_ANNOTATION_BY_IDDeletes the annotation that matches the specified ID.

Deletes the annotation that matches the specified ID.

Authentication

Connected account required

Tags

annotations
Deletes a cloud migration token.GRAFANA_DELETE_CLOUD_MIGRATION_TOKENDeletes a cloud migration token.

Deletes a cloud migration token.

Authentication

Connected account required

Tags

migrations
Delete a correlation.GRAFANA_DELETE_CORRELATIONDelete a correlation.

Delete a correlation.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

dashboards
Delete Snapshot by Key.GRAFANA_DELETE_DASHBOARD_SNAPSHOTDelete Snapshot by Key.

Delete Snapshot by Key.

Authentication

Connected account required

Tags

dashboardssnapshots
Delete Snapshot by deleteKey.GRAFANA_DELETE_DASHBOARD_SNAPSHOT_BY_DELETE_KEYSnapshot public mode should be enabled or authentication is required.

Snapshot public mode should be enabled or authentication is required.

Authentication

Connected account required

Tags

dashboardssnapshots
Delete an existing data source by name. This function will be removed in the future.GRAFANA_DELETE_DATA_SOURCE_BY_NAMEIf 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).

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).

Authentication

Connected account required

Tags

datasources
Delete an existing data source by UID.GRAFANA_DELETE_DATA_SOURCE_BY_UIDIf 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).

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).

Authentication

Connected account required

Tags

datasources
Delete folder.GRAFANA_DELETE_FOLDERDeletes 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}

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}

Authentication

Connected account required

Tags

folders
Delete library element.GRAFANA_DELETE_LIBRARY_ELEMENT_BY_UIDDeletes 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.

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.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

licensingenterprise
Delete Organization.GRAFANA_DELETE_ORG_BY_IDDelete Organization.

Delete Organization.

Authentication

Connected account required

Tags

orgs
Delete playlist.GRAFANA_DELETE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).

Please refer to [new API](?api=playlist.grafana.app-v1).

Authentication

Connected account required

Tags

playlists
DeletePublicDashboardGRAFANA_DELETE_PUBLIC_DASHBOARDDelete public dashboard for a dashboard

Delete public dashboard for a dashboard

Authentication

Connected account required

Tags

dashboardsdashboard_public
Delete query in query history.GRAFANA_DELETE_QUERYDeletes an existing query in query history as specified by the UID. This operation cannot be reverted.

Deletes an existing query in query history as specified by the UID. This operation cannot be reverted.

Authentication

Connected account required

Tags

query_history
Delete removes the rule from the registry and stops it.GRAFANA_DELETE_RECORDING_RULEDelete removes the rule from the registry and stops it.

Delete removes the rule from the registry and stops it.

Authentication

Connected account required

Tags

recording_rulesenterprise
Delete the remote write target.GRAFANA_DELETE_RECORDING_RULE_WRITE_TARGETDelete the remote write target.

Delete the remote write target.

Authentication

Connected account required

Tags

recording_rulesenterprise
Delete a report.GRAFANA_DELETE_REPORTAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports.delete` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports.delete` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Authentication

Connected account required

Tags

reportsenterprise
Delete a custom role.GRAFANA_DELETE_ROLEDelete 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 custom role with the same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to delete a custom role which allows to do that.

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 custom role with the same, or a subset of permissions which the user has. For example, if a user does not have required permissions for creating users, they won’t be able to delete a custom role which allows to do that.

Authentication

Connected account required

Tags

access_controlenterprise
Delete service accountGRAFANA_DELETE_SERVICE_ACCOUNTRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:delete` scope: `serviceaccounts:id:1` (single service account)

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:delete` scope: `serviceaccounts:id:1` (single service account)

Authentication

Connected account required

Tags

service_accounts
Delete a migration session by its uid.GRAFANA_DELETE_SESSIONDelete a migration session by its uid.

Delete a migration session by its uid.

Authentication

Connected account required

Tags

migrations
Delete Team By ID.GRAFANA_DELETE_TEAM_BY_IDDelete Team By ID.

Delete Team By ID.

Authentication

Connected account required

Tags

teams
DeleteToken deletes service account tokensGRAFANA_DELETE_TOKENRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account) Requires basic authentication and that the authenticated user is a Grafana Admin.

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account) Requires basic authentication and that the authenticated user is a Grafana Admin.

Authentication

Connected account required

Tags

service_accounts
DisableDataSourceCacheGRAFANA_DISABLE_DATA_SOURCE_CACHEdisable cache for a single data source

disable cache for a single data source

Authentication

Connected account required

Tags

enterprise
EnableDataSourceCacheGRAFANA_ENABLE_DATA_SOURCE_CACHEenable cache for a single data source

enable cache for a single data source

Authentication

Connected account required

Tags

enterprise
Get status.GRAFANA_GET_ACCESS_CONTROL_STATUSReturns 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`.

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`.

Authentication

Connected account required

Tags

access_controlenterprise
Get Annotation by ID.GRAFANA_GET_ANNOTATION_BY_IDGet Annotation by ID.

Get Annotation by ID.

Authentication

Connected account required

Tags

annotations
Find Annotations Tags.GRAFANA_GET_ANNOTATION_TAGSFind all the event tags created in the annotations.

Find all the event tags created in the annotations.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

annotations
Fetch the cloud migration token if it exists.GRAFANA_GET_CLOUD_MIGRATION_TOKENFetch the cloud migration token if it exists.

Fetch the cloud migration token if it exists.

Authentication

Connected account required

Tags

migrations
Gets a correlation.GRAFANA_GET_CORRELATIONGets a correlation.

Gets a correlation.

Authentication

Connected account required

Tags

datasourcescorrelations
Gets all correlations.GRAFANA_GET_CORRELATIONSGets all correlations.

Gets all correlations.

Authentication

Connected account required

Tags

datasourcescorrelations
Gets all correlations originating from the given data source.GRAFANA_GET_CORRELATIONS_BY_SOURCE_UIDGets all correlations originating from the given data source.

Gets all correlations originating from the given data source.

Authentication

Connected account required

Tags

datasourcescorrelations
Get current Organization.GRAFANA_GET_CURRENT_ORGGet current Organization.

Get current Organization.

Authentication

Connected account required

Tags

org
Fetch Organization quota.GRAFANA_GET_CURRENT_ORG_QUOTAIf 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).

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).

Authentication

Connected account required

Tags

quotaorg
Get custom permissions report in CSV format.GRAFANA_GET_CUSTOM_PERMISSIONS_CSVYou need to have a permission with action `licensing.reports:read`.

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

Authentication

Connected account required

Tags

licensingenterprise
Get custom permissions report.GRAFANA_GET_CUSTOM_PERMISSIONS_REPORTYou need to have a permission with action `licensing.reports:read`.

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

Authentication

Connected account required

Tags

licensingenterprise
Get dashboard by uid.GRAFANA_GET_DASHBOARD_BY_UIDOptional 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/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}

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/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}

Authentication

Connected account required

Tags

dashboards
Gets all existing permissions for the given dashboard.GRAFANA_GET_DASHBOARD_PERMISSIONS_LIST_BY_UIDUse: /apis/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}/access

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

Authentication

Connected account required

Tags

dashboardspermissions
Get Snapshot by Key.GRAFANA_GET_DASHBOARD_SNAPSHOTGet Snapshot by Key.

Get Snapshot by Key.

Authentication

Connected account required

Tags

dashboardssnapshots
Get all dashboards tags of an organization.GRAFANA_GET_DASHBOARD_TAGSGet all dashboards tags of an organization.

Get all dashboards tags of an organization.

Authentication

Connected account required

Tags

dashboards
Get a specific dashboard version using UID.GRAFANA_GET_DASHBOARD_VERSION_BY_UIDGet a specific dashboard version using UID.

Get a specific dashboard version using UID.

Authentication

Connected account required

Tags

dashboardsversions
Gets all existing versions for the dashboard using UID.GRAFANA_GET_DASHBOARD_VERSIONS_BY_UIDGets all existing versions for the dashboard using UID.

Gets all existing versions for the dashboard using UID.

Authentication

Connected account required

Tags

dashboardsversions
Get a single data source by Name. This function will be removed in the future.GRAFANA_GET_DATA_SOURCE_BY_NAMEIf 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).

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).

Authentication

Connected account required

Tags

datasources
Get a single data source by UID.GRAFANA_GET_DATA_SOURCE_BY_UIDIf 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).

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).

Authentication

Connected account required

Tags

datasources
GetDataSourceCacheConfigGRAFANA_GET_DATA_SOURCE_CACHE_CONFIGget cache config for a single data source

get cache config for a single data source

Authentication

Connected account required

Tags

enterprise
Get data source Id by Name. This function will be removed in the future.GRAFANA_GET_DATA_SOURCE_ID_BY_NAMEIf 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).

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).

Authentication

Connected account required

Tags

datasources
Get all data sources.GRAFANA_GET_DATA_SOURCESIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

datasources
Get folder by uid.GRAFANA_GET_FOLDER_BY_UIDUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

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

Authentication

Connected account required

Tags

folders
Gets the count of each descendant of a folder by kind. The folder is identified by UID.GRAFANA_GET_FOLDER_DESCENDANT_COUNTSUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

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

Authentication

Connected account required

Tags

folders
Gets all existing permissions for the folder with the given `uid`.GRAFANA_GET_FOLDER_PERMISSION_LISTGets all existing permissions for the folder with the given `uid`.

Gets all existing permissions for the folder with the given `uid`.

Authentication

Connected account required

Tags

folderspermissions
Get all folders.GRAFANA_GET_FOLDERSIt 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 view. Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders

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 view. Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders

Authentication

Connected account required

Tags

folders
GetHealthGRAFANA_GET_HEALTHapiHealthHandler 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.

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.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

dashboards
Attempts to connect to all the configured LDAP servers and returns information on whenever they're available or not.GRAFANA_GET_LDAPSTATUSIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.status: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`.

Authentication

Connected account required

Tags

admin_ldap
Get library element by name.GRAFANA_GET_LIBRARY_ELEMENT_BY_NAMEReturns a library element with the given name.

Returns a library element with the given name.

Authentication

Connected account required

Tags

library_elements
Get library element by UID.GRAFANA_GET_LIBRARY_ELEMENT_BY_UIDReturns a library element with the given UID.

Returns a library element with the given UID.

Authentication

Connected account required

Tags

library_elements
Get library element connections.GRAFANA_GET_LIBRARY_ELEMENT_CONNECTIONSReturns a list of connections for a library element based on the UID specified.

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

Authentication

Connected account required

Tags

library_elements
Get all library elements.GRAFANA_GET_LIBRARY_ELEMENTSReturns 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.

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.

Authentication

Connected account required

Tags

library_elements
Get license token.GRAFANA_GET_LICENSE_TOKENYou need to have a permission with action `licensing:read`.

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

Authentication

Connected account required

Tags

licensingenterprise
It exposes the SP (Grafana's) metadata for the IdP's consumption.GRAFANA_GET_METADATAIt exposes the SP (Grafana's) metadata for the IdP's consumption.

It exposes the SP (Grafana's) metadata for the IdP's consumption.

Authentication

Connected account required

Tags

samlenterprise
Get Organization by ID.GRAFANA_GET_ORG_BY_IDGet Organization by ID.

Get Organization by ID.

Authentication

Connected account required

Tags

orgs
Get Organization by Name.GRAFANA_GET_ORG_BY_NAMEGet Organization by Name.

Get Organization by Name.

Authentication

Connected account required

Tags

orgs
Get Current Org Prefs.GRAFANA_GET_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Authentication

Connected account required

Tags

orgpreferences
Fetch Organization quota.GRAFANA_GET_ORG_QUOTAIf 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).

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).

Authentication

Connected account required

Tags

quotaorgs
Get Users in Organization.GRAFANA_GET_ORG_USERSIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

orgs
Get all users within the current organization.GRAFANA_GET_ORG_USERS_FOR_CURRENT_ORGReturns 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:*`.

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:*`.

Authentication

Connected account required

Tags

org
Get all users within the current organization (lookup)GRAFANA_GET_ORG_USERS_FOR_CURRENT_ORG_LOOKUPReturns 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.

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.

Authentication

Connected account required

Tags

org
Get pending invites.GRAFANA_GET_PENDING_ORG_INVITESGet pending invites.

Get pending invites.

Authentication

Connected account required

Tags

orginvites
Get playlist.GRAFANA_GET_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).

Please refer to [new API](?api=playlist.grafana.app-v1).

Authentication

Connected account required

Tags

playlists
Get playlist items.GRAFANA_GET_PLAYLIST_ITEMSPlease refer to [new API](?api=playlist.grafana.app-v1) instead (items are included in the playlist spec).

Please refer to [new API](?api=playlist.grafana.app-v1) instead (items are included in the playlist spec).

Authentication

Connected account required

Tags

playlists
Get an SSO Settings entry by KeyGRAFANA_GET_PROVIDER_SETTINGSYou need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.

You need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.

Authentication

Connected account required

Tags

sso_settings
GetPublicAnnotationsGRAFANA_GET_PUBLIC_ANNOTATIONSGet annotations for a public dashboard

Get annotations for a public dashboard

Authentication

Connected account required

Tags

dashboardsannotationsdashboard_public
GetPublicDashboardGRAFANA_GET_PUBLIC_DASHBOARDGet public dashboard by dashboardUid

Get public dashboard by dashboardUid

Authentication

Connected account required

Tags

dashboardsdashboard_public
Return the prometheus remote write target.GRAFANA_GET_RECORDING_RULE_WRITE_TARGETReturn the prometheus remote write target.

Return the prometheus remote write target.

Authentication

Connected account required

Tags

recording_rulesenterprise
Get a report.GRAFANA_GET_REPORTAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Authentication

Connected account required

Tags

reportsenterprise
Get report settings.GRAFANA_GET_REPORT_SETTINGSAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:read`x.

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:read`x.

Authentication

Connected account required

Tags

reportsenterprise
List reports.GRAFANA_GET_REPORTSAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:*`.

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:*`.

Authentication

Connected account required

Tags

reportsenterprise
List reports by dashboard uid.GRAFANA_GET_REPORTS_BY_DASHBOARD_UIDAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:*`.

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports:read` with scope `reports:*`.

Authentication

Connected account required

Tags

reportsenterprise
Get the resource dependencies graph for the current set of migratable resources.GRAFANA_GET_RESOURCE_DEPENDENCIESGet the resource dependencies graph for the current set of migratable resources.

Get the resource dependencies graph for the current set of migratable resources.

Authentication

Connected account required

Tags

migrations
Get a description of a resource's access control properties.GRAFANA_GET_RESOURCE_DESCRIPTIONGet a description of a resource's access control properties.

Get a description of a resource's access control properties.

Authentication

Connected account required

Tags

access_control
Get permissions for a resource.GRAFANA_GET_RESOURCE_PERMISSIONSGet permissions for a resource.

Get permissions for a resource.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

access_controlenterprise
Get role assignments.GRAFANA_GET_ROLE_ASSIGNMENTSGet 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:*`.

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:*`.

Authentication

Connected account required

Tags

access_controlenterprise
GetLogout initiates single logout process.GRAFANA_GET_SAMLLOGOUTGetLogout initiates single logout process.

GetLogout initiates single logout process.

Authentication

Connected account required

Tags

samlenterprise
Get a cloud migration session by its uid.GRAFANA_GET_SESSIONGet a cloud migration session by its uid.

Get a cloud migration session by its uid.

Authentication

Connected account required

Tags

migrations
Get a list of all cloud migration sessions that have been created.GRAFANA_GET_SESSION_LISTGet a list of all cloud migration sessions that have been created.

Get a list of all cloud migration sessions that have been created.

Authentication

Connected account required

Tags

migrations
Get custom branding report image.GRAFANA_GET_SETTINGS_IMAGEAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:read`.

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:read`.

Authentication

Connected account required

Tags

reportsenterprise
Get a list of snapshots for a session.GRAFANA_GET_SHAPSHOT_LISTGet a list of snapshots for a session.

Get a list of snapshots for a session.

Authentication

Connected account required

Tags

migrations
Get snapshot sharing settings.GRAFANA_GET_SHARING_OPTIONSGet snapshot sharing settings.

Get snapshot sharing settings.

Authentication

Connected account required

Tags

snapshots
GetSignedInUserGRAFANA_GET_SIGNED_IN_USERGet (current authenticated user)

Get (current authenticated user)

Authentication

Connected account required

Tags

signed_in_user
Organizations of the actual User.GRAFANA_GET_SIGNED_IN_USER_ORG_LISTReturn a list of all organizations of the current user.

Return a list of all organizations of the current user.

Authentication

Connected account required

Tags

signed_in_user
Teams that the actual User is member of.GRAFANA_GET_SIGNED_IN_USER_TEAM_LISTReturn a list of all teams that the current user is member of.

Return a list of all teams that the current user is member of.

Authentication

Connected account required

Tags

signed_in_user
It performs Single Logout (SLO) callback.GRAFANA_GET_SLOThere might be two possible requests: 1. Logout response (callback) when Grafana initiates single logout and IdP returns response to logout request. 2. Logout request when another SP initiates single logout and IdP sends logout request to the Grafana, or in case of IdP-initiated logout.

There might be two possible requests: 1. Logout response (callback) when Grafana initiates single logout and IdP returns response to logout request. 2. Logout request when another SP initiates single logout and IdP sends logout request to the Grafana, or in case of IdP-initiated logout.

Authentication

Connected account required

Tags

samlenterprise
Get metadata about a snapshot, including where it is in its processing and final results.GRAFANA_GET_SNAPSHOTGet metadata about a snapshot, including where it is in its processing and final results.

Get metadata about a snapshot, including where it is in its processing and final results.

Authentication

Connected account required

Tags

migrations
Check license availability.GRAFANA_GET_STATUSCheck license availability.

Check license availability.

Authentication

Connected account required

Tags

licensingenterprise
Returns the current state of the LDAP background sync integration.GRAFANA_GET_SYNC_STATUSYou need to have a permission with action `ldap.status:read`.

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

Authentication

Connected account required

Tags

admin_ldapenterprise
Get Team By ID.GRAFANA_GET_TEAM_BY_IDGet Team By ID.

Get Team By ID.

Authentication

Connected account required

Tags

teams
Get External Groups.GRAFANA_GET_TEAM_GROUPS_APIGet External Groups.

Get External Groups.

Authentication

Connected account required

Tags

sync_team_groupsenterprise
Retrieves LBAC rules for a team.GRAFANA_GET_TEAM_LBACRULES_APIRetrieves LBAC rules for a team.

Retrieves LBAC rules for a team.

Authentication

Connected account required

Tags

enterprise
Get Team Members.GRAFANA_GET_TEAM_MEMBERSGet Team Members.

Get Team Members.

Authentication

Connected account required

Tags

teams
Get Team Preferences.GRAFANA_GET_TEAM_PREFERENCESGet Team Preferences.

Get Team Preferences.

Authentication

Connected account required

Tags

teamspreferences
Auth tokens of the actual User.GRAFANA_GET_USER_AUTH_TOKENSReturn a list of all auth tokens (devices) that the actual user currently have logged in from.

Return a list of all auth tokens (devices) that the actual user currently have logged in from.

Authentication

Connected account required

Tags

signed_in_user
Get user by id.GRAFANA_GET_USER_BY_IDGet user by id.

Get user by id.

Authentication

Connected account required

Tags

users
Get user by login or email.GRAFANA_GET_USER_BY_LOGIN_OR_EMAILGet user by login or email.

Get user by login or email.

Authentication

Connected account required

Tags

users
Finds an user based on a username in LDAP. This helps illustrate how would the particular user be mapped in Grafana when synced.GRAFANA_GET_USER_FROM_LDAPIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.user: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`.

Authentication

Connected account required

Tags

admin_ldap
Get organizations for user.GRAFANA_GET_USER_ORG_LISTGet organizations for user identified by id.

Get organizations for user identified by id.

Authentication

Connected account required

Tags

users
Get user preferences.GRAFANA_GET_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Authentication

Connected account required

Tags

signed_in_userpreferences
Fetch user quota.GRAFANA_GET_USER_QUOTAIf 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).

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).

Authentication

Connected account required

Tags

quotaadmin_users
Fetch user quota.GRAFANA_GET_USER_QUOTASFetch user quota.

Fetch user quota.

Authentication

Connected account required

Tags

quotasigned_in_user
Get teams for user.GRAFANA_GET_USER_TEAMSGet teams for user identified by id.

Get teams for user identified by id.

Authentication

Connected account required

Tags

users
Import dashboard.GRAFANA_IMPORT_DASHBOARDImport dashboard.

Import dashboard.

Authentication

Connected account required

Tags

dashboards
Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.GRAFANA_INTERPOLATE_DASHBOARDInterpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.

Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.

Authentication

Connected account required

Tags

dashboards
List all SSO Settings entriesGRAFANA_LIST_ALL_PROVIDERS_SETTINGSYou need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.

You need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.

Authentication

Connected account required

Tags

sso_settings
Lists all devices within the last 30 daysGRAFANA_LIST_DEVICESLists all devices within the last 30 days

Lists all devices within the last 30 days

Authentication

Connected account required

Tags

devices
ListPublicDashboardsGRAFANA_LIST_PUBLIC_DASHBOARDSGet list of public dashboards

Get list of public dashboards

Authentication

Connected account required

Tags

dashboardsdashboard_public
Lists all rules in the database: active or deleted.GRAFANA_LIST_RECORDING_RULESLists all rules in the database: active or deleted.

Lists all rules in the database: active or deleted.

Authentication

Connected account required

Tags

recording_rulesenterprise
Get all roles.GRAFANA_LIST_ROLESGets 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.

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.

Authentication

Connected account required

Tags

access_controlenterprise
List search sorting options.GRAFANA_LIST_SORT_OPTIONSList search sorting options.

List search sorting options.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

access_controlenterprise
List roles assigned to multiple teams.GRAFANA_LIST_TEAMS_ROLESLists 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:*`.

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:*`.

Authentication

Connected account required

Tags

access_controlenterprise
Get service account tokensGRAFANA_LIST_TOKENSRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `global:serviceaccounts:id:1` (single service account) Requires basic authentication and that the authenticated user is a Grafana Admin.

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `global:serviceaccounts:id:1` (single service account) Requires basic authentication and that the authenticated user is a Grafana Admin.

Authentication

Connected account required

Tags

service_accounts
List roles assigned to a user.GRAFANA_LIST_USER_ROLESLists 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>`.

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>`.

Authentication

Connected account required

Tags

access_controlenterprise
List roles assigned to multiple users.GRAFANA_LIST_USERS_ROLESLists 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:*`.

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:*`.

Authentication

Connected account required

Tags

access_controlenterprise
Delete multiple annotations.GRAFANA_MASS_DELETE_ANNOTATIONSDelete multiple annotations.

Delete multiple annotations.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

folders
Patch Annotation.GRAFANA_PATCH_ANNOTATIONUpdates 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.

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.

Authentication

Connected account required

Tags

annotations
Patch Current Org Prefs.GRAFANA_PATCH_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Authentication

Connected account required

Tags

orgpreferences
Patch SSO SettingsGRAFANA_PATCH_PROVIDER_SETTINGSPartially updates the SSO Settings for a provider. Only provided fields are updated. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Partially updates the SSO Settings for a provider. Only provided fields are updated. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Authentication

Connected account required

Tags

sso_settings
Update comment for query in query history.GRAFANA_PATCH_QUERY_COMMENTUpdates comment for query in query history as specified by the UID.

Updates comment for query in query history as specified by the UID.

Authentication

Connected account required

Tags

query_history
Patch user preferences.GRAFANA_PATCH_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Authentication

Connected account required

Tags

signed_in_userpreferences
It performs Assertion Consumer Service (ACS).GRAFANA_POST_ACSIt performs Assertion Consumer Service (ACS).

It performs Assertion Consumer Service (ACS).

Authentication

Connected account required

Tags

samlenterprise
Create Annotation.GRAFANA_POST_ANNOTATIONCreates 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. The response for this HTTP request is slightly different in versions prior to v6.4. In prior versions you would also get an endId if you where creating a region. But in 6.4 regions are represented using a single event with time and timeEnd properties.

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. The response for this HTTP request is slightly different in versions prior to v6.4. In prior versions you would also get an endId if you where creating a region. But in 6.4 regions are represented using a single event with time and timeEnd properties.

Authentication

Connected account required

Tags

annotations
Create / Update dashboardGRAFANA_POST_DASHBOARDCreates 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/dashboard.grafana.app/v1/namespaces/{ns}/dashboards

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/dashboard.grafana.app/v1/namespaces/{ns}/dashboards

Authentication

Connected account required

Tags

dashboards
Create Annotation in Graphite format.GRAFANA_POST_GRAPHITE_ANNOTATIONCreates 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).

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).

Authentication

Connected account required

Tags

annotations
Create license token.GRAFANA_POST_LICENSE_TOKENYou need to have a permission with action `licensing:write`.

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

Authentication

Connected account required

Tags

licensingenterprise
Manually force license refresh.GRAFANA_POST_RENEW_LICENSE_TOKENManually ask license issuer for a new token. Available in Grafana Enterprise v7.4+. You need to have a permission with action `licensing: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`.

Authentication

Connected account required

Tags

licensingenterprise
It performs Single Logout (SLO) callback.GRAFANA_POST_SLOThere might be two possible requests: 1. Logout response (callback) when Grafana initiates single logout and IdP returns response to logout request. 2. Logout request when another SP initiates single logout and IdP sends logout request to the Grafana, or in case of IdP-initiated logout.

There might be two possible requests: 1. Logout response (callback) when Grafana initiates single logout and IdP returns response to logout request. 2. Logout request when another SP initiates single logout and IdP sends logout request to the Grafana, or in case of IdP-initiated logout.

Authentication

Connected account required

Tags

samlenterprise
Enables a single Grafana user to be synchronized against LDAP.GRAFANA_POST_SYNC_USER_WITH_LDAPIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.user:sync`.

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

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

datasources
QueryPublicDashboardGRAFANA_QUERY_PUBLIC_DASHBOARDGet results for a given panel on a public dashboard

Get results for a given panel on a public dashboard

Authentication

Connected account required

Tags

dashboardsdashboard_public
Refresh license stats.GRAFANA_REFRESH_LICENSE_STATSYou need to have a permission with action `licensing:read`.

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

Authentication

Connected account required

Tags

licensingenterprise
Reloads the LDAP configuration.GRAFANA_RELOAD_LDAPCFGIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.config:reload`.

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

Authentication

Connected account required

Tags

admin_ldap
Delete user in current organization.GRAFANA_REMOVE_ORG_USERIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

orgs
Delete user in current organization.GRAFANA_REMOVE_ORG_USER_FOR_CURRENT_ORGIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

org
Remove SSO SettingsGRAFANA_REMOVE_PROVIDER_SETTINGSRemoves the SSO Settings for a provider. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Removes the SSO Settings for a provider. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Authentication

Connected account required

Tags

sso_settings
Remove External Group.GRAFANA_REMOVE_TEAM_GROUP_API_QUERYRemove External Group.

Remove External Group.

Authentication

Connected account required

Tags

sync_team_groupsenterprise
Remove Member From Team.GRAFANA_REMOVE_TEAM_MEMBERRemove Member From Team.

Remove Member From Team.

Authentication

Connected account required

Tags

teams
Remove team role.GRAFANA_REMOVE_TEAM_ROLEYou need to have a permission with action `teams.roles:remove` and scope `permissions:type:delegate`.

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

Authentication

Connected account required

Tags

access_controlenterprise
Remove a user role assignment.GRAFANA_REMOVE_USER_ROLERevoke 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 users, they won’t be able to unassign a role which will allow to do that. This is done to prevent escalation of privileges.

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 users, they won’t be able to unassign a role which will allow to do that. This is done to prevent escalation of privileges.

Authentication

Connected account required

Tags

access_controlenterprise
Download a CSV report.GRAFANA_RENDER_REPORT_CSVSAvailable to all users and with a valid license.

Available to all users and with a valid license.

Authentication

Connected account required

Tags

reportsenterprise
Render report for multiple dashboards.GRAFANA_RENDER_REPORT_PDFSAvailable to all users and with a valid license.

Available to all users and with a valid license.

Authentication

Connected account required

Tags

reportsenterprise
Restore a dashboard to a given dashboard version using UID.GRAFANA_RESTORE_DASHBOARD_VERSION_BY_UIDThis API will be removed when /apis/dashboard.grafana.app/v1 is released. You can restore a dashboard by reading it from history, then creating it again.

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

Authentication

Connected account required

Tags

dashboardsversions
Get JSON Web Key Set (JWKS) with all the keys that can be used to verify tokens (public keys)GRAFANA_RETRIEVE_JWKSRequired permissions None

Required permissions None

Authentication

Connected account required

Tags

signing_keys
Get single serviceaccount by IdGRAFANA_RETRIEVE_SERVICE_ACCOUNTRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `serviceaccounts:id:1` (single service account)

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `serviceaccounts:id:1` (single service account)

Authentication

Connected account required

Tags

service_accounts
Revoke invite.GRAFANA_REVOKE_INVITERevoke invite.

Revoke invite.

Authentication

Connected account required

Tags

orginvites
Revoke an auth token of the actual User.GRAFANA_REVOKE_USER_AUTH_TOKENRevokes the given auth token (device) for the actual user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.

Revokes the given auth token (device) for the actual user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.

Authentication

Connected account required

Tags

signed_in_user
Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_DELETE_NAMESPACEDeletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.

Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.

Authentication

Connected account required

Tags

convert_prometheus
Deletes a specific rule group if it was imported from a Prometheus-compatible source.GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_DELETE_RULE_GROUPDeletes a specific rule group if it was imported from a Prometheus-compatible source.

Deletes a specific rule group if it was imported from a Prometheus-compatible source.

Authentication

Connected account required

Tags

convert_prometheus
Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_GET_NAMESPACEGets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).

Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).

Authentication

Connected account required

Tags

convert_prometheus
Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_GET_RULE_GROUPGets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.

Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.

Authentication

Connected account required

Tags

convert_prometheus
Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_GET_RULESGets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.

Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.

Authentication

Connected account required

Tags

convert_prometheus
Converts the submitted rule groups into Grafana-Managed Rules.GRAFANA_ROUTE_CONVERT_PROMETHEUS_CORTEX_POST_RULE_GROUPSConverts the submitted rule groups into Grafana-Managed Rules.

Converts the submitted rule groups into Grafana-Managed Rules.

Authentication

Connected account required

Tags

convert_prometheus
Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.GRAFANA_ROUTE_CONVERT_PROMETHEUS_DELETE_NAMESPACEDeletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.

Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.

Authentication

Connected account required

Tags

convert_prometheus
Deletes a specific rule group if it was imported from a Prometheus-compatible source.GRAFANA_ROUTE_CONVERT_PROMETHEUS_DELETE_RULE_GROUPDeletes a specific rule group if it was imported from a Prometheus-compatible source.

Deletes a specific rule group if it was imported from a Prometheus-compatible source.

Authentication

Connected account required

Tags

convert_prometheus
Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).GRAFANA_ROUTE_CONVERT_PROMETHEUS_GET_NAMESPACEGets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).

Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).

Authentication

Connected account required

Tags

convert_prometheus
Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.GRAFANA_ROUTE_CONVERT_PROMETHEUS_GET_RULE_GROUPGets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.

Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.

Authentication

Connected account required

Tags

convert_prometheus
Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.GRAFANA_ROUTE_CONVERT_PROMETHEUS_GET_RULESGets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.

Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.

Authentication

Connected account required

Tags

convert_prometheus
Converts the submitted rule groups into Grafana-Managed Rules.GRAFANA_ROUTE_CONVERT_PROMETHEUS_POST_RULE_GROUPSConverts the submitted rule groups into Grafana-Managed Rules.

Converts the submitted rule groups into Grafana-Managed Rules.

Authentication

Connected account required

Tags

convert_prometheus
Delete a specific alert rule by UID.GRAFANA_ROUTE_DELETE_ALERT_RULEDelete a specific alert rule by UID.

Delete a specific alert rule by UID.

Authentication

Connected account required

Tags

provisioning
RouteDeleteAlertRuleGroupGRAFANA_ROUTE_DELETE_ALERT_RULE_GROUPDelete rule group

Delete rule group

Authentication

Connected account required

Tags

provisioning
Delete a contact point.GRAFANA_ROUTE_DELETE_CONTACTPOINTSDelete a contact point.

Delete a contact point.

Authentication

Connected account required

Tags

provisioning
Delete a mute timing.GRAFANA_ROUTE_DELETE_MUTE_TIMINGDelete a mute timing.

Delete a mute timing.

Authentication

Connected account required

Tags

provisioning
Delete a notification template group.GRAFANA_ROUTE_DELETE_TEMPLATEDelete a notification template group.

Delete a notification template group.

Authentication

Connected account required

Tags

provisioning
Export a mute timing in provisioning format.GRAFANA_ROUTE_EXPORT_MUTE_TIMINGExport a mute timing in provisioning format.

Export a mute timing in provisioning format.

Authentication

Connected account required

Tags

provisioning
Export all mute timings in provisioning format.GRAFANA_ROUTE_EXPORT_MUTE_TIMINGSExport all mute timings in provisioning format.

Export all mute timings in provisioning format.

Authentication

Connected account required

Tags

provisioning
Get a specific alert rule by UID.GRAFANA_ROUTE_GET_ALERT_RULEGet a specific alert rule by UID.

Get a specific alert rule by UID.

Authentication

Connected account required

Tags

provisioning
Export an alert rule in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULE_EXPORTExport an alert rule in provisioning file format.

Export an alert rule in provisioning file format.

Authentication

Connected account required

Tags

provisioning
Get a rule group.GRAFANA_ROUTE_GET_ALERT_RULE_GROUPGet a rule group.

Get a rule group.

Authentication

Connected account required

Tags

provisioning
Export an alert rule group in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULE_GROUP_EXPORTExport an alert rule group in provisioning file format.

Export an alert rule group in provisioning file format.

Authentication

Connected account required

Tags

provisioning
Get all the alert rules.GRAFANA_ROUTE_GET_ALERT_RULESGet all the alert rules.

Get all the alert rules.

Authentication

Connected account required

Tags

provisioning
Export all alert rules in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULES_EXPORTExport all alert rules in provisioning file format.

Export all alert rules in provisioning file format.

Authentication

Connected account required

Tags

provisioning
Get all the contact points.GRAFANA_ROUTE_GET_CONTACTPOINTSGet all the contact points.

Get all the contact points.

Authentication

Connected account required

Tags

provisioning
Export all contact points in provisioning file format.GRAFANA_ROUTE_GET_CONTACTPOINTS_EXPORTExport all contact points in provisioning file format.

Export all contact points in provisioning file format.

Authentication

Connected account required

Tags

provisioning
Get a mute timing.GRAFANA_ROUTE_GET_MUTE_TIMINGGet a mute timing.

Get a mute timing.

Authentication

Connected account required

Tags

provisioning
Get all the mute timings.GRAFANA_ROUTE_GET_MUTE_TIMINGSGet all the mute timings.

Get all the mute timings.

Authentication

Connected account required

Tags

provisioning
Get the notification policy tree.GRAFANA_ROUTE_GET_POLICY_TREEGet the notification policy tree.

Get the notification policy tree.

Authentication

Connected account required

Tags

provisioning
Export the notification policy tree in provisioning file format.GRAFANA_ROUTE_GET_POLICY_TREE_EXPORTExport the notification policy tree in provisioning file format.

Export the notification policy tree in provisioning file format.

Authentication

Connected account required

Tags

provisioning
Get a notification template group.GRAFANA_ROUTE_GET_TEMPLATEGet a notification template group.

Get a notification template group.

Authentication

Connected account required

Tags

provisioning
Get all notification template groups.GRAFANA_ROUTE_GET_TEMPLATESGet all notification template groups.

Get all notification template groups.

Authentication

Connected account required

Tags

provisioning
Create a new alert rule.GRAFANA_ROUTE_POST_ALERT_RULECreate a new alert rule.

Create a new alert rule.

Authentication

Connected account required

Tags

provisioning
Create a contact point.GRAFANA_ROUTE_POST_CONTACTPOINTSCreate a contact point.

Create a contact point.

Authentication

Connected account required

Tags

provisioning
Create a new mute timing.GRAFANA_ROUTE_POST_MUTE_TIMINGCreate a new mute timing.

Create a new mute timing.

Authentication

Connected account required

Tags

provisioning
Update an existing alert rule.GRAFANA_ROUTE_PUT_ALERT_RULEUpdate an existing alert rule.

Update an existing alert rule.

Authentication

Connected account required

Tags

provisioning
Create or update alert rule group.GRAFANA_ROUTE_PUT_ALERT_RULE_GROUPCreate or update alert rule group.

Create or update alert rule group.

Authentication

Connected account required

Tags

provisioning
Update an existing contact point.GRAFANA_ROUTE_PUT_CONTACTPOINTUpdate an existing contact point.

Update an existing contact point.

Authentication

Connected account required

Tags

provisioning
Replace an existing mute timing.GRAFANA_ROUTE_PUT_MUTE_TIMINGReplace an existing mute timing.

Replace an existing mute timing.

Authentication

Connected account required

Tags

provisioning
Sets the notification policy tree.GRAFANA_ROUTE_PUT_POLICY_TREESets the notification policy tree.

Sets the notification policy tree.

Authentication

Connected account required

Tags

provisioning
Updates an existing notification template group.GRAFANA_ROUTE_PUT_TEMPLATEUpdates an existing notification template group.

Updates an existing notification template group.

Authentication

Connected account required

Tags

provisioning
Clears the notification policy tree.GRAFANA_ROUTE_RESET_POLICY_TREEClears the notification policy tree.

Clears the notification policy tree.

Authentication

Connected account required

Tags

provisioning
Save settings.GRAFANA_SAVE_REPORT_SETTINGSAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:write`xx.

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports.settings:write`xx.

Authentication

Connected account required

Tags

reportsenterprise
SearchGRAFANA_SEARCHSearch

Search

Authentication

Connected account required

Tags

search
List snapshots.GRAFANA_SEARCH_DASHBOARD_SNAPSHOTSList snapshots.

List snapshots.

Authentication

Connected account required

Tags

dashboardssnapshots
Lists all devices within the last 30 daysGRAFANA_SEARCH_DEVICESLists all devices within the last 30 days

Lists all devices within the last 30 days

Authentication

Connected account required

Tags

devices
Search service accounts with pagingGRAFANA_SEARCH_ORG_SERVICE_ACCOUNTS_WITH_PAGINGRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `serviceaccounts:*`

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:read` scope: `serviceaccounts:*`

Authentication

Connected account required

Tags

service_accounts
Search Users in Organization.GRAFANA_SEARCH_ORG_USERSIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

orgs
Search all Organizations.GRAFANA_SEARCH_ORGSSearch all Organizations.

Search all Organizations.

Authentication

Connected account required

Tags

orgs
Get playlists.GRAFANA_SEARCH_PLAYLISTSPlease refer to [new API](?api=playlist.grafana.app-v1).

Please refer to [new API](?api=playlist.grafana.app-v1).

Authentication

Connected account required

Tags

playlists
Query history search.GRAFANA_SEARCH_QUERIESReturns a list of queries in the query history that matches the search criteria. Query history search supports pagination. Use the `limit` parameter to control the maximum number of queries returned; the default limit is 100. You can also use the `page` query parameter to fetch queries from any page other than the first one.

Returns a list of queries in the query history that matches the search criteria. Query history search supports pagination. Use the `limit` parameter to control the maximum number of queries returned; the default limit is 100. You can also use the `page` query parameter to fetch queries from any page other than the first one.

Authentication

Connected account required

Tags

query_history
Search for team groups with optional filtering and pagination.GRAFANA_SEARCH_TEAM_GROUPSSearch for team groups with optional filtering and pagination.

Search for team groups with optional filtering and pagination.

Authentication

Connected account required

Tags

sync_team_groupsenterprise
Team Search With Paging.GRAFANA_SEARCH_TEAMSTeam Search With Paging.

Team Search With Paging.

Authentication

Connected account required

Tags

teams
Get users.GRAFANA_SEARCH_USERSReturns all users that the authenticated user has permission to view, admin permission required.

Returns all users that the authenticated user has permission to view, admin permission required.

Authentication

Connected account required

Tags

users
Get users with paging.GRAFANA_SEARCH_USERS_WITH_PAGINGGet users with paging.

Get users with paging.

Authentication

Connected account required

Tags

users
Send a report.GRAFANA_SEND_REPORTGenerate and send a report. This API waits for the report to be generated before returning. We recommend that you set the client’s timeout to at least 60 seconds. Available to org admins only and with a valid license. Only available in Grafana Enterprise v7.0+. This API endpoint is experimental and may be deprecated in a future release. On deprecation, a migration strategy will be provided and the endpoint will remain functional until the next major release of Grafana. You need to have a permission with action `reports:send`.

Generate and send a report. This API waits for the report to be generated before returning. We recommend that you set the client’s timeout to at least 60 seconds. Available to org admins only and with a valid license. Only available in Grafana Enterprise v7.0+. This API endpoint is experimental and may be deprecated in a future release. On deprecation, a migration strategy will be provided and the endpoint will remain functional until the next major release of Grafana. You need to have a permission with action `reports:send`.

Authentication

Connected account required

Tags

reportsenterprise
Send test report via email.GRAFANA_SEND_TEST_EMAILAvailable to org admins only and with a valid license. You need to have a permission with action `reports:send`.

Available to org admins only and with a valid license. You need to have a permission with action `reports:send`.

Authentication

Connected account required

Tags

reportsenterprise
SetDataSourceCacheConfigGRAFANA_SET_DATA_SOURCE_CACHE_CONFIGset cache config for a single data source

set cache config for a single data source

Authentication

Connected account required

Tags

enterprise
Set resource permissions.GRAFANA_SET_RESOURCE_PERMISSIONSAssigns 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.

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.

Authentication

Connected account required

Tags

access_control
Set resource permissions for a built-in role.GRAFANA_SET_RESOURCE_PERMISSIONS_FOR_BUILT_IN_ROLEAssigns 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.

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.

Authentication

Connected account required

Tags

access_control
Set resource permissions for a team.GRAFANA_SET_RESOURCE_PERMISSIONS_FOR_TEAMAssigns 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.

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.

Authentication

Connected account required

Tags

access_control
Set resource permissions for a user.GRAFANA_SET_RESOURCE_PERMISSIONS_FOR_USERAssigns 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.

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.

Authentication

Connected account required

Tags

access_control
Set role assignments.GRAFANA_SET_ROLE_ASSIGNMENTSSet 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`.

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`.

Authentication

Connected account required

Tags

access_controlenterprise
Set team memberships.GRAFANA_SET_TEAM_MEMBERSHIPSTakes user emails, and updates team members and admins to the provided lists of users. Any current team members and admins not in the provided lists will be removed.

Takes user emails, and updates team members and admins to the provided lists of users. Any current team members and admins not in the provided lists will be removed.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

access_controlenterprise
Set user role assignments.GRAFANA_SET_USER_ROLESUpdate 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. You need to have a permission with action `users.roles:add` and `users.roles:remove` and scope `permissions:type:delegate` for each. `permissions:type:delegate` scope ensures that users can only assign or 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 users, they won’t be able to assign or unassign a role which will allow to do that. This is done to prevent escalation of privileges.

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. You need to have a permission with action `users.roles:add` and `users.roles:remove` and scope `permissions:type:delegate` for each. `permissions:type:delegate` scope ensures that users can only assign or 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 users, they won’t be able to assign or unassign a role which will allow to do that. This is done to prevent escalation of privileges.

Authentication

Connected account required

Tags

access_controlenterprise
Star a dashboard.GRAFANA_STAR_DASHBOARD_BY_UIDStars the given Dashboard for the actual user.

Stars the given Dashboard for the actual user.

Authentication

Connected account required

Tags

signed_in_user
Add star to query in query history.GRAFANA_STAR_QUERYAdds star to query in query history as specified by the UID.

Adds star to query in query history as specified by the UID.

Authentication

Connected account required

Tags

query_history
Test a recording rule.GRAFANA_TEST_CREATE_RECORDING_RULETest a recording rule.

Test a recording rule.

Authentication

Connected account required

Tags

recording_rulesenterprise
Unstar a dashboard.GRAFANA_UNSTAR_DASHBOARD_BY_UIDDeletes the starring of the given Dashboard for the actual user.

Deletes the starring of the given Dashboard for the actual user.

Authentication

Connected account required

Tags

signed_in_user
Remove star to query in query history.GRAFANA_UNSTAR_QUERYRemoves star from query in query history as specified by the UID.

Removes star from query in query history as specified by the UID.

Authentication

Connected account required

Tags

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

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

Authentication

Connected account required

Tags

annotations
Updates a correlation.GRAFANA_UPDATE_CORRELATIONUpdates a correlation.

Updates a correlation.

Authentication

Connected account required

Tags

datasourcescorrelations
Update current Organization.GRAFANA_UPDATE_CURRENT_ORGUpdate current Organization.

Update current Organization.

Authentication

Connected account required

Tags

org
Update current Organization's address.GRAFANA_UPDATE_CURRENT_ORG_ADDRESSUpdate current Organization's address.

Update current Organization's address.

Authentication

Connected account required

Tags

org
Updates permissions for a dashboard.GRAFANA_UPDATE_DASHBOARD_PERMISSIONS_BY_UIDThis operation will remove existing permissions if they’re not included in the request.

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

Authentication

Connected account required

Tags

dashboardspermissions
Update an existing data source.GRAFANA_UPDATE_DATA_SOURCE_BY_UIDSimilar 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: `datasources:write` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).

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: `datasources:write` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).

Authentication

Connected account required

Tags

datasources
Update folder.GRAFANA_UPDATE_FOLDERUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}

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

Authentication

Connected account required

Tags

folders
Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.GRAFANA_UPDATE_FOLDER_PERMISSIONSUpdates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.

Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.

Authentication

Connected account required

Tags

folderspermissions
Update library element.GRAFANA_UPDATE_LIBRARY_ELEMENTUpdates an existing library element identified by uid.

Updates an existing library element identified by uid.

Authentication

Connected account required

Tags

library_elements
Update Organization.GRAFANA_UPDATE_ORGUpdate Organization.

Update Organization.

Authentication

Connected account required

Tags

orgs
Update Organization's address.GRAFANA_UPDATE_ORG_ADDRESSUpdate Organization's address.

Update Organization's address.

Authentication

Connected account required

Tags

orgs
Update Current Org Prefs.GRAFANA_UPDATE_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace

Authentication

Connected account required

Tags

orgpreferences
Update user quota.GRAFANA_UPDATE_ORG_QUOTAIf 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).

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).

Authentication

Connected account required

Tags

quotaorgs
Update Users in Organization.GRAFANA_UPDATE_ORG_USERIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

orgs
Updates the given user.GRAFANA_UPDATE_ORG_USER_FOR_CURRENT_ORGIf 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:*`.

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:*`.

Authentication

Connected account required

Tags

org
Update playlist.GRAFANA_UPDATE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).

Please refer to [new API](?api=playlist.grafana.app-v1).

Authentication

Connected account required

Tags

playlists
Update SSO SettingsGRAFANA_UPDATE_PROVIDER_SETTINGSInserts or updates the SSO Settings for a provider. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Inserts or updates the SSO Settings for a provider. You need to have a permission with action `settings:write` and scope `settings:auth.<provider>:*`.

Authentication

Connected account required

Tags

sso_settings
UpdatePublicDashboardGRAFANA_UPDATE_PUBLIC_DASHBOARDUpdate public dashboard for a dashboard

Update public dashboard for a dashboard

Authentication

Connected account required

Tags

dashboardsdashboard_public
Update the active status of a rule.GRAFANA_UPDATE_RECORDING_RULEUpdate the active status of a rule.

Update the active status of a rule.

Authentication

Connected account required

Tags

recording_rulesenterprise
Update a report.GRAFANA_UPDATE_REPORTAvailable to org admins only and with a valid or expired license. You need to have a permission with action `reports.admin:write` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Available to org admins only and with a valid or expired license. You need to have a permission with action `reports.admin:write` with scope `reports:id:<report ID>`. Requesting reports using the internal id will stop workgin in the future Use the reporting apiserver to manage reports. See: /apis/reporting.grafana.app/

Authentication

Connected account required

Tags

reportsenterprise
Update a custom role.GRAFANA_UPDATE_ROLEYou 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.

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.

Authentication

Connected account required

Tags

access_controlenterprise
Update service accountGRAFANA_UPDATE_SERVICE_ACCOUNTRequired permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account)

Required permissions (See note in the [introduction](https://grafana.com/docs/grafana/latest/developers/http_api/serviceaccount/#service-account-api) for an explanation): action: `serviceaccounts:write` scope: `serviceaccounts:id:1` (single service account)

Authentication

Connected account required

Tags

service_accounts
Update signed in User.GRAFANA_UPDATE_SIGNED_IN_USERUpdate signed in User.

Update signed in User.

Authentication

Connected account required

Tags

signed_in_user
Update Team.GRAFANA_UPDATE_TEAMUpdate Team.

Update Team.

Authentication

Connected account required

Tags

teams
Updates LBAC rules for a team.GRAFANA_UPDATE_TEAM_LBACRULES_APIUpdates LBAC rules for a team.

Updates LBAC rules for a team.

Authentication

Connected account required

Tags

enterprise
Update Team Member.GRAFANA_UPDATE_TEAM_MEMBERUpdate Team Member.

Update Team Member.

Authentication

Connected account required

Tags

teams
Update Team Preferences.GRAFANA_UPDATE_TEAM_PREFERENCESUpdate Team Preferences.

Update Team Preferences.

Authentication

Connected account required

Tags

teamspreferences
Update user.GRAFANA_UPDATE_USERUpdate the user identified by id.

Update the user identified by id.

Authentication

Connected account required

Tags

users
Update user email.GRAFANA_UPDATE_USER_EMAILUpdate the email of user given a verification code.

Update the email of user given a verification code.

Authentication

Connected account required

Tags

user
Update user preferences.GRAFANA_UPDATE_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}

Authentication

Connected account required

Tags

signed_in_userpreferences
Update user quota.GRAFANA_UPDATE_USER_QUOTAIf 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).

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).

Authentication

Connected account required

Tags

quotaadmin_users
Upload a snapshot to the Grafana Migration Service for processing.GRAFANA_UPLOAD_SNAPSHOTUpload a snapshot to the Grafana Migration Service for processing.

Upload a snapshot to the Grafana Migration Service for processing.

Authentication

Connected account required

Tags

migrations
Switch user context for signed in user.GRAFANA_USER_SET_USING_ORGSwitch user context to the given organization.

Switch user context to the given organization.

Authentication

Connected account required

Tags

signed_in_user
ViewPublicDashboardGRAFANA_VIEW_PUBLIC_DASHBOARDGet public dashboard for view

Get public dashboard for view

Authentication

Connected account required

Tags

dashboardsdashboard_public

Provider resources