Grafana
No catalog description yet.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| API Key | api_key | available | — |
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`Connection
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 requiredTags
Add invite.GRAFANA_ADD_ORG_INVITEAdd invite.Connection
Add invite.
Authentication
Connected account requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Add External Group.GRAFANA_ADD_TEAM_GROUP_APIAdd External Group.Connection
Add External Group.
Authentication
Connected account requiredTags
Add Team Member.GRAFANA_ADD_TEAM_MEMBERAdd Team Member.Connection
Add Team Member.
Authentication
Connected account requiredTags
Add team role.GRAFANA_ADD_TEAM_ROLEYou need to have a permission with action `teams.roles:add` and scope `permissions:type:delegate`.Connection
You need to have a permission with action `teams.roles:add` and scope `permissions:type:delegate`.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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).Connection
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 requiredTags
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).Connection
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 requiredTags
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).Connection
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 requiredTags
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`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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`.Connection
You need to have a permission with action `provisioning:reload` with scope `provisioners:accesscontrol`.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
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`.Connection
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 requiredTags
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`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Fetch data source resources.GRAFANA_CALL_DATASOURCE_RESOURCE_WITH_UIDFetch data source resources.Connection
Fetch data source resources.
Authentication
Connected account requiredTags
Cancel a snapshot, wherever it is in its processing chain.GRAFANA_CANCEL_SNAPSHOTTODO: ImplementConnection
TODO: Implement
Authentication
Connected account requiredTags
Change Password.GRAFANA_CHANGE_USER_PASSWORDChanges the password for the user.Connection
Changes the password for the user.
Authentication
Connected account requiredTags
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.Connection
Sends a health check request to the plugin datasource identified by the UID.
Authentication
Connected account requiredTags
CleanDataSourceCacheGRAFANA_CLEAN_DATA_SOURCE_CACHEclean cache for a single data sourceConnection
clean cache for a single data source
Authentication
Connected account requiredTags
Create gcom access token.GRAFANA_CREATE_CLOUD_MIGRATION_TOKENCreate gcom access token.Connection
Create gcom access token.
Authentication
Connected account requiredTags
Add correlation.GRAFANA_CREATE_CORRELATIONAdd correlation.Connection
Add correlation.
Authentication
Connected account requiredTags
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.Connection
Snapshot public mode should be enabled or authentication is required.
Authentication
Connected account requiredTags
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}Connection
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 requiredTags
Create library element.GRAFANA_CREATE_LIBRARY_ELEMENTCreates a new library element.Connection
Creates a new library element.
Authentication
Connected account requiredTags
Create Organization.GRAFANA_CREATE_ORGOnly works if [users.allow_org_create](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_org_create) is set.Connection
Only works if [users.allow_org_create](https://grafana.com/docs/grafana/latest/administration/configuration/#allow_org_create) is set.
Authentication
Connected account requiredTags
Create playlist.GRAFANA_CREATE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).Connection
Please refer to [new API](?api=playlist.grafana.app-v1).
Authentication
Connected account requiredTags
CreatePublicDashboardGRAFANA_CREATE_PUBLIC_DASHBOARDCreate public dashboard for a dashboardConnection
Create public dashboard for a dashboard
Authentication
Connected account requiredTags
Add query to query history.GRAFANA_CREATE_QUERYAdds new query to query history.Connection
Adds new query to query history.
Authentication
Connected account requiredTags
Create a recording rule that is then registered and started.GRAFANA_CREATE_RECORDING_RULECreate a recording rule that is then registered and started.Connection
Create a recording rule that is then registered and started.
Authentication
Connected account requiredTags
Create a remote write target.GRAFANA_CREATE_RECORDING_RULE_WRITE_TARGETIt returns a 422 if there is not an existing prometheus data source configured.Connection
It returns a 422 if there is not an existing prometheus data source configured.
Authentication
Connected account requiredTags
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`.Connection
Available to org admins only and with a valid license. You need to have a permission with action `reports.admin:create`.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
Create a migration session.GRAFANA_CREATE_SESSIONCreate a migration session.Connection
Create a migration session.
Authentication
Connected account requiredTags
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.Connection
If the snapshot initialization is successful, the snapshot uid is returned.
Authentication
Connected account requiredTags
Add Team.GRAFANA_CREATE_TEAMAdd Team.Connection
Add Team.
Authentication
Connected account requiredTags
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)Connection
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 requiredTags
Data source proxy DELETE calls.GRAFANA_DATASOURCE_PROXY_DELETEBY_UIDCALLSProxies all calls to the actual data source.Connection
Proxies all calls to the actual data source.
Authentication
Connected account requiredTags
Data source proxy GET calls.GRAFANA_DATASOURCE_PROXY_GETBY_UIDCALLSProxies all calls to the actual data source.Connection
Proxies all calls to the actual data source.
Authentication
Connected account requiredTags
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 definedConnection
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 requiredTags
Delete Annotation By ID.GRAFANA_DELETE_ANNOTATION_BY_IDDeletes the annotation that matches the specified ID.Connection
Deletes the annotation that matches the specified ID.
Authentication
Connected account requiredTags
Deletes a cloud migration token.GRAFANA_DELETE_CLOUD_MIGRATION_TOKENDeletes a cloud migration token.Connection
Deletes a cloud migration token.
Authentication
Connected account requiredTags
Delete a correlation.GRAFANA_DELETE_CORRELATIONDelete a correlation.Connection
Delete a correlation.
Authentication
Connected account requiredTags
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}Connection
Will delete the dashboard given the specified unique identifier (uid). Use: /apis/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}
Authentication
Connected account requiredTags
Delete Snapshot by Key.GRAFANA_DELETE_DASHBOARD_SNAPSHOTDelete Snapshot by Key.Connection
Delete Snapshot by Key.
Authentication
Connected account requiredTags
Delete Snapshot by deleteKey.GRAFANA_DELETE_DASHBOARD_SNAPSHOT_BY_DELETE_KEYSnapshot public mode should be enabled or authentication is required.Connection
Snapshot public mode should be enabled or authentication is required.
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
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).Connection
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 requiredTags
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}Connection
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 requiredTags
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.Connection
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 requiredTags
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`.Connection
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 requiredTags
Delete Organization.GRAFANA_DELETE_ORG_BY_IDDelete Organization.Connection
Delete Organization.
Authentication
Connected account requiredTags
Delete playlist.GRAFANA_DELETE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).Connection
Please refer to [new API](?api=playlist.grafana.app-v1).
Authentication
Connected account requiredTags
DeletePublicDashboardGRAFANA_DELETE_PUBLIC_DASHBOARDDelete public dashboard for a dashboardConnection
Delete public dashboard for a dashboard
Authentication
Connected account requiredTags
Delete query in query history.GRAFANA_DELETE_QUERYDeletes an existing query in query history as specified by the UID. This operation cannot be reverted.Connection
Deletes an existing query in query history as specified by the UID. This operation cannot be reverted.
Authentication
Connected account requiredTags
Delete removes the rule from the registry and stops it.GRAFANA_DELETE_RECORDING_RULEDelete removes the rule from the registry and stops it.Connection
Delete removes the rule from the registry and stops it.
Authentication
Connected account requiredTags
Delete the remote write target.GRAFANA_DELETE_RECORDING_RULE_WRITE_TARGETDelete the remote write target.Connection
Delete the remote write target.
Authentication
Connected account requiredTags
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/Connection
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 requiredTags
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.Connection
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 requiredTags
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)Connection
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 requiredTags
Delete a migration session by its uid.GRAFANA_DELETE_SESSIONDelete a migration session by its uid.Connection
Delete a migration session by its uid.
Authentication
Connected account requiredTags
Delete Team By ID.GRAFANA_DELETE_TEAM_BY_IDDelete Team By ID.Connection
Delete Team By ID.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
DisableDataSourceCacheGRAFANA_DISABLE_DATA_SOURCE_CACHEdisable cache for a single data sourceConnection
disable cache for a single data source
Authentication
Connected account requiredTags
EnableDataSourceCacheGRAFANA_ENABLE_DATA_SOURCE_CACHEenable cache for a single data sourceConnection
enable cache for a single data source
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
Get Annotation by ID.GRAFANA_GET_ANNOTATION_BY_IDGet Annotation by ID.Connection
Get Annotation by ID.
Authentication
Connected account requiredTags
Find Annotations Tags.GRAFANA_GET_ANNOTATION_TAGSFind all the event tags created in the annotations.Connection
Find all the event tags created in the annotations.
Authentication
Connected account requiredTags
Find Annotations.GRAFANA_GET_ANNOTATIONSStarting in Grafana v6.4 regions annotations are now returned in one entity that now includes the timeEnd property.Connection
Starting in Grafana v6.4 regions annotations are now returned in one entity that now includes the timeEnd property.
Authentication
Connected account requiredTags
Fetch the cloud migration token if it exists.GRAFANA_GET_CLOUD_MIGRATION_TOKENFetch the cloud migration token if it exists.Connection
Fetch the cloud migration token if it exists.
Authentication
Connected account requiredTags
Gets a correlation.GRAFANA_GET_CORRELATIONGets a correlation.Connection
Gets a correlation.
Authentication
Connected account requiredTags
Gets all correlations.GRAFANA_GET_CORRELATIONSGets all correlations.Connection
Gets all correlations.
Authentication
Connected account requiredTags
Gets all correlations originating from the given data source.GRAFANA_GET_CORRELATIONS_BY_SOURCE_UIDGets all correlations originating from the given data source.Connection
Gets all correlations originating from the given data source.
Authentication
Connected account requiredTags
Get current Organization.GRAFANA_GET_CURRENT_ORGGet current Organization.Connection
Get current Organization.
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
Get custom permissions report in CSV format.GRAFANA_GET_CUSTOM_PERMISSIONS_CSVYou need to have a permission with action `licensing.reports:read`.Connection
You need to have a permission with action `licensing.reports:read`.
Authentication
Connected account requiredTags
Get custom permissions report.GRAFANA_GET_CUSTOM_PERMISSIONS_REPORTYou need to have a permission with action `licensing.reports:read`.Connection
You need to have a permission with action `licensing.reports:read`.
Authentication
Connected account requiredTags
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}Connection
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 requiredTags
Gets all existing permissions for the given dashboard.GRAFANA_GET_DASHBOARD_PERMISSIONS_LIST_BY_UIDUse: /apis/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}/accessConnection
Use: /apis/dashboard.grafana.app/v1/namespaces/{ns}/dashboards/{uid}/access
Authentication
Connected account requiredTags
Get Snapshot by Key.GRAFANA_GET_DASHBOARD_SNAPSHOTGet Snapshot by Key.Connection
Get Snapshot by Key.
Authentication
Connected account requiredTags
Get all dashboards tags of an organization.GRAFANA_GET_DASHBOARD_TAGSGet all dashboards tags of an organization.Connection
Get all dashboards tags of an organization.
Authentication
Connected account requiredTags
Get a specific dashboard version using UID.GRAFANA_GET_DASHBOARD_VERSION_BY_UIDGet a specific dashboard version using UID.Connection
Get a specific dashboard version using UID.
Authentication
Connected account requiredTags
Gets all existing versions for the dashboard using UID.GRAFANA_GET_DASHBOARD_VERSIONS_BY_UIDGets all existing versions for the dashboard using UID.Connection
Gets all existing versions for the dashboard using UID.
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
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).Connection
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 requiredTags
GetDataSourceCacheConfigGRAFANA_GET_DATA_SOURCE_CACHE_CONFIGget cache config for a single data sourceConnection
get cache config for a single data source
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Get folder by uid.GRAFANA_GET_FOLDER_BY_UIDUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}Connection
Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}
Authentication
Connected account requiredTags
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}Connection
Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}
Authentication
Connected account requiredTags
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`.Connection
Gets all existing permissions for the folder with the given `uid`.
Authentication
Connected account requiredTags
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}/foldersConnection
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 requiredTags
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.Connection
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 requiredTags
GetHomeDashboardGRAFANA_GET_HOME_DASHBOARDNOTE: the home dashboard is configured in preferences. This API will be removed in G13Connection
NOTE: the home dashboard is configured in preferences. This API will be removed in G13
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
Get library element by name.GRAFANA_GET_LIBRARY_ELEMENT_BY_NAMEReturns a library element with the given name.Connection
Returns a library element with the given name.
Authentication
Connected account requiredTags
Get library element by UID.GRAFANA_GET_LIBRARY_ELEMENT_BY_UIDReturns a library element with the given UID.Connection
Returns a library element with the given UID.
Authentication
Connected account requiredTags
Get library element connections.GRAFANA_GET_LIBRARY_ELEMENT_CONNECTIONSReturns a list of connections for a library element based on the UID specified.Connection
Returns a list of connections for a library element based on the UID specified.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Get license token.GRAFANA_GET_LICENSE_TOKENYou need to have a permission with action `licensing:read`.Connection
You need to have a permission with action `licensing:read`.
Authentication
Connected account requiredTags
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.Connection
It exposes the SP (Grafana's) metadata for the IdP's consumption.
Authentication
Connected account requiredTags
Get Organization by ID.GRAFANA_GET_ORG_BY_IDGet Organization by ID.Connection
Get Organization by ID.
Authentication
Connected account requiredTags
Get Organization by Name.GRAFANA_GET_ORG_BY_NAMEGet Organization by Name.Connection
Get Organization by Name.
Authentication
Connected account requiredTags
Get Current Org Prefs.GRAFANA_GET_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespaceConnection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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.Connection
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 requiredTags
Get pending invites.GRAFANA_GET_PENDING_ORG_INVITESGet pending invites.Connection
Get pending invites.
Authentication
Connected account requiredTags
Get playlist.GRAFANA_GET_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).Connection
Please refer to [new API](?api=playlist.grafana.app-v1).
Authentication
Connected account requiredTags
Get playlist items.GRAFANA_GET_PLAYLIST_ITEMSPlease refer to [new API](?api=playlist.grafana.app-v1) instead (items are included in the playlist spec).Connection
Please refer to [new API](?api=playlist.grafana.app-v1) instead (items are included in the playlist spec).
Authentication
Connected account requiredTags
Get an SSO Settings entry by KeyGRAFANA_GET_PROVIDER_SETTINGSYou need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.Connection
You need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.
Authentication
Connected account requiredTags
GetPublicAnnotationsGRAFANA_GET_PUBLIC_ANNOTATIONSGet annotations for a public dashboardConnection
Get annotations for a public dashboard
Authentication
Connected account requiredTags
GetPublicDashboardGRAFANA_GET_PUBLIC_DASHBOARDGet public dashboard by dashboardUidConnection
Get public dashboard by dashboardUid
Authentication
Connected account requiredTags
Return the prometheus remote write target.GRAFANA_GET_RECORDING_RULE_WRITE_TARGETReturn the prometheus remote write target.Connection
Return the prometheus remote write target.
Authentication
Connected account requiredTags
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/Connection
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 requiredTags
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.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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.Connection
Get the resource dependencies graph for the current set of migratable resources.
Authentication
Connected account requiredTags
Get a description of a resource's access control properties.GRAFANA_GET_RESOURCE_DESCRIPTIONGet a description of a resource's access control properties.Connection
Get a description of a resource's access control properties.
Authentication
Connected account requiredTags
Get permissions for a resource.GRAFANA_GET_RESOURCE_PERMISSIONSGet permissions for a resource.Connection
Get permissions for a resource.
Authentication
Connected account requiredTags
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:*`.Connection
Get a role for the given UID. You need to have a permission with action `roles:read` and scope `roles:*`.
Authentication
Connected account requiredTags
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:*`.Connection
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 requiredTags
GetLogout initiates single logout process.GRAFANA_GET_SAMLLOGOUTGetLogout initiates single logout process.Connection
GetLogout initiates single logout process.
Authentication
Connected account requiredTags
Get a cloud migration session by its uid.GRAFANA_GET_SESSIONGet a cloud migration session by its uid.Connection
Get a cloud migration session by its uid.
Authentication
Connected account requiredTags
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.Connection
Get a list of all cloud migration sessions that have been created.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
Get a list of snapshots for a session.GRAFANA_GET_SHAPSHOT_LISTGet a list of snapshots for a session.Connection
Get a list of snapshots for a session.
Authentication
Connected account requiredTags
Get snapshot sharing settings.GRAFANA_GET_SHARING_OPTIONSGet snapshot sharing settings.Connection
Get snapshot sharing settings.
Authentication
Connected account requiredTags
GetSignedInUserGRAFANA_GET_SIGNED_IN_USERGet (current authenticated user)Connection
Get (current authenticated user)
Authentication
Connected account requiredTags
Organizations of the actual User.GRAFANA_GET_SIGNED_IN_USER_ORG_LISTReturn a list of all organizations of the current user.Connection
Return a list of all organizations of the current user.
Authentication
Connected account requiredTags
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.Connection
Return a list of all teams that the current user is member of.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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.Connection
Get metadata about a snapshot, including where it is in its processing and final results.
Authentication
Connected account requiredTags
Check license availability.GRAFANA_GET_STATUSCheck license availability.Connection
Check license availability.
Authentication
Connected account requiredTags
Returns the current state of the LDAP background sync integration.GRAFANA_GET_SYNC_STATUSYou need to have a permission with action `ldap.status:read`.Connection
You need to have a permission with action `ldap.status:read`.
Authentication
Connected account requiredTags
Get Team By ID.GRAFANA_GET_TEAM_BY_IDGet Team By ID.Connection
Get Team By ID.
Authentication
Connected account requiredTags
Get External Groups.GRAFANA_GET_TEAM_GROUPS_APIGet External Groups.Connection
Get External Groups.
Authentication
Connected account requiredTags
Retrieves LBAC rules for a team.GRAFANA_GET_TEAM_LBACRULES_APIRetrieves LBAC rules for a team.Connection
Retrieves LBAC rules for a team.
Authentication
Connected account requiredTags
Get Team Members.GRAFANA_GET_TEAM_MEMBERSGet Team Members.Connection
Get Team Members.
Authentication
Connected account requiredTags
Get Team Preferences.GRAFANA_GET_TEAM_PREFERENCESGet Team Preferences.Connection
Get Team Preferences.
Authentication
Connected account requiredTags
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.Connection
Return a list of all auth tokens (devices) that the actual user currently have logged in from.
Authentication
Connected account requiredTags
Get user by id.GRAFANA_GET_USER_BY_IDGet user by id.Connection
Get user by id.
Authentication
Connected account requiredTags
Get user by login or email.GRAFANA_GET_USER_BY_LOGIN_OR_EMAILGet user by login or email.Connection
Get user by login or email.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
Get organizations for user.GRAFANA_GET_USER_ORG_LISTGet organizations for user identified by id.Connection
Get organizations for user identified by id.
Authentication
Connected account requiredTags
Get user preferences.GRAFANA_GET_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}Connection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
Fetch user quota.GRAFANA_GET_USER_QUOTASFetch user quota.Connection
Fetch user quota.
Authentication
Connected account requiredTags
Get teams for user.GRAFANA_GET_USER_TEAMSGet teams for user identified by id.Connection
Get teams for user identified by id.
Authentication
Connected account requiredTags
Import dashboard.GRAFANA_IMPORT_DASHBOARDImport dashboard.Connection
Import dashboard.
Authentication
Connected account requiredTags
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.Connection
Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.
Authentication
Connected account requiredTags
List all SSO Settings entriesGRAFANA_LIST_ALL_PROVIDERS_SETTINGSYou need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.Connection
You need to have a permission with action `settings:read` with scope `settings:auth.<provider>:*`.
Authentication
Connected account requiredTags
Lists all devices within the last 30 daysGRAFANA_LIST_DEVICESLists all devices within the last 30 daysConnection
Lists all devices within the last 30 days
Authentication
Connected account requiredTags
ListPublicDashboardsGRAFANA_LIST_PUBLIC_DASHBOARDSGet list of public dashboardsConnection
Get list of public dashboards
Authentication
Connected account requiredTags
Lists all rules in the database: active or deleted.GRAFANA_LIST_RECORDING_RULESLists all rules in the database: active or deleted.Connection
Lists all rules in the database: active or deleted.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
List search sorting options.GRAFANA_LIST_SORT_OPTIONSList search sorting options.Connection
List search sorting options.
Authentication
Connected account requiredTags
Get team roles.GRAFANA_LIST_TEAM_ROLESYou need to have a permission with action `teams.roles:read` and scope `teams:id:<team ID>`.Connection
You need to have a permission with action `teams.roles:read` and scope `teams:id:<team ID>`.
Authentication
Connected account requiredTags
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:*`.Connection
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 requiredTags
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.Connection
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 requiredTags
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>`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Delete multiple annotations.GRAFANA_MASS_DELETE_ANNOTATIONSDelete multiple annotations.Connection
Delete multiple annotations.
Authentication
Connected account requiredTags
Move folder.GRAFANA_MOVE_FOLDERUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}, Changing the parent folder annotationConnection
Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}, Changing the parent folder annotation
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Patch Current Org Prefs.GRAFANA_PATCH_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespaceConnection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace
Authentication
Connected account requiredTags
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>:*`.Connection
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 requiredTags
Update comment for query in query history.GRAFANA_PATCH_QUERY_COMMENTUpdates comment for query in query history as specified by the UID.Connection
Updates comment for query in query history as specified by the UID.
Authentication
Connected account requiredTags
Patch user preferences.GRAFANA_PATCH_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}Connection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}
Authentication
Connected account requiredTags
It performs Assertion Consumer Service (ACS).GRAFANA_POST_ACSIt performs Assertion Consumer Service (ACS).Connection
It performs Assertion Consumer Service (ACS).
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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}/dashboardsConnection
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 requiredTags
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).Connection
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 requiredTags
Create license token.GRAFANA_POST_LICENSE_TOKENYou need to have a permission with action `licensing:write`.Connection
You need to have a permission with action `licensing:write`.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
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.Connection
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 requiredTags
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`.Connection
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 requiredTags
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`.Connection
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 requiredTags
QueryPublicDashboardGRAFANA_QUERY_PUBLIC_DASHBOARDGet results for a given panel on a public dashboardConnection
Get results for a given panel on a public dashboard
Authentication
Connected account requiredTags
Refresh license stats.GRAFANA_REFRESH_LICENSE_STATSYou need to have a permission with action `licensing:read`.Connection
You need to have a permission with action `licensing:read`.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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>:*`.Connection
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 requiredTags
Remove External Group.GRAFANA_REMOVE_TEAM_GROUP_API_QUERYRemove External Group.Connection
Remove External Group.
Authentication
Connected account requiredTags
Remove Member From Team.GRAFANA_REMOVE_TEAM_MEMBERRemove Member From Team.Connection
Remove Member From Team.
Authentication
Connected account requiredTags
Remove team role.GRAFANA_REMOVE_TEAM_ROLEYou need to have a permission with action `teams.roles:remove` and scope `permissions:type:delegate`.Connection
You need to have a permission with action `teams.roles:remove` and scope `permissions:type:delegate`.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Download a CSV report.GRAFANA_RENDER_REPORT_CSVSAvailable to all users and with a valid license.Connection
Available to all users and with a valid license.
Authentication
Connected account requiredTags
Render report for multiple dashboards.GRAFANA_RENDER_REPORT_PDFSAvailable to all users and with a valid license.Connection
Available to all users and with a valid license.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Get JSON Web Key Set (JWKS) with all the keys that can be used to verify tokens (public keys)GRAFANA_RETRIEVE_JWKSRequired permissions NoneConnection
Required permissions None
Authentication
Connected account requiredTags
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)Connection
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 requiredTags
Revoke invite.GRAFANA_REVOKE_INVITERevoke invite.Connection
Revoke invite.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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.Connection
Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.
Authentication
Connected account requiredTags
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.Connection
Deletes a specific rule group if it was imported from a Prometheus-compatible source.
Authentication
Connected account requiredTags
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).Connection
Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).
Authentication
Connected account requiredTags
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.Connection
Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.
Authentication
Connected account requiredTags
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.Connection
Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.
Authentication
Connected account requiredTags
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.Connection
Converts the submitted rule groups into Grafana-Managed Rules.
Authentication
Connected account requiredTags
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.Connection
Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.
Authentication
Connected account requiredTags
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.Connection
Deletes a specific rule group if it was imported from a Prometheus-compatible source.
Authentication
Connected account requiredTags
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).Connection
Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).
Authentication
Connected account requiredTags
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.Connection
Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.
Authentication
Connected account requiredTags
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.Connection
Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.
Authentication
Connected account requiredTags
Converts the submitted rule groups into Grafana-Managed Rules.GRAFANA_ROUTE_CONVERT_PROMETHEUS_POST_RULE_GROUPSConverts the submitted rule groups into Grafana-Managed Rules.Connection
Converts the submitted rule groups into Grafana-Managed Rules.
Authentication
Connected account requiredTags
Delete a specific alert rule by UID.GRAFANA_ROUTE_DELETE_ALERT_RULEDelete a specific alert rule by UID.Connection
Delete a specific alert rule by UID.
Authentication
Connected account requiredTags
RouteDeleteAlertRuleGroupGRAFANA_ROUTE_DELETE_ALERT_RULE_GROUPDelete rule groupConnection
Delete rule group
Authentication
Connected account requiredTags
Delete a contact point.GRAFANA_ROUTE_DELETE_CONTACTPOINTSDelete a contact point.Connection
Delete a contact point.
Authentication
Connected account requiredTags
Delete a mute timing.GRAFANA_ROUTE_DELETE_MUTE_TIMINGDelete a mute timing.Connection
Delete a mute timing.
Authentication
Connected account requiredTags
Delete a notification template group.GRAFANA_ROUTE_DELETE_TEMPLATEDelete a notification template group.Connection
Delete a notification template group.
Authentication
Connected account requiredTags
Export a mute timing in provisioning format.GRAFANA_ROUTE_EXPORT_MUTE_TIMINGExport a mute timing in provisioning format.Connection
Export a mute timing in provisioning format.
Authentication
Connected account requiredTags
Export all mute timings in provisioning format.GRAFANA_ROUTE_EXPORT_MUTE_TIMINGSExport all mute timings in provisioning format.Connection
Export all mute timings in provisioning format.
Authentication
Connected account requiredTags
Get a specific alert rule by UID.GRAFANA_ROUTE_GET_ALERT_RULEGet a specific alert rule by UID.Connection
Get a specific alert rule by UID.
Authentication
Connected account requiredTags
Export an alert rule in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULE_EXPORTExport an alert rule in provisioning file format.Connection
Export an alert rule in provisioning file format.
Authentication
Connected account requiredTags
Get a rule group.GRAFANA_ROUTE_GET_ALERT_RULE_GROUPGet a rule group.Connection
Get a rule group.
Authentication
Connected account requiredTags
Export an alert rule group in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULE_GROUP_EXPORTExport an alert rule group in provisioning file format.Connection
Export an alert rule group in provisioning file format.
Authentication
Connected account requiredTags
Get all the alert rules.GRAFANA_ROUTE_GET_ALERT_RULESGet all the alert rules.Connection
Get all the alert rules.
Authentication
Connected account requiredTags
Export all alert rules in provisioning file format.GRAFANA_ROUTE_GET_ALERT_RULES_EXPORTExport all alert rules in provisioning file format.Connection
Export all alert rules in provisioning file format.
Authentication
Connected account requiredTags
Get all the contact points.GRAFANA_ROUTE_GET_CONTACTPOINTSGet all the contact points.Connection
Get all the contact points.
Authentication
Connected account requiredTags
Export all contact points in provisioning file format.GRAFANA_ROUTE_GET_CONTACTPOINTS_EXPORTExport all contact points in provisioning file format.Connection
Export all contact points in provisioning file format.
Authentication
Connected account requiredTags
Get a mute timing.GRAFANA_ROUTE_GET_MUTE_TIMINGGet a mute timing.Connection
Get a mute timing.
Authentication
Connected account requiredTags
Get all the mute timings.GRAFANA_ROUTE_GET_MUTE_TIMINGSGet all the mute timings.Connection
Get all the mute timings.
Authentication
Connected account requiredTags
Get the notification policy tree.GRAFANA_ROUTE_GET_POLICY_TREEGet the notification policy tree.Connection
Get the notification policy tree.
Authentication
Connected account requiredTags
Export the notification policy tree in provisioning file format.GRAFANA_ROUTE_GET_POLICY_TREE_EXPORTExport the notification policy tree in provisioning file format.Connection
Export the notification policy tree in provisioning file format.
Authentication
Connected account requiredTags
Get a notification template group.GRAFANA_ROUTE_GET_TEMPLATEGet a notification template group.Connection
Get a notification template group.
Authentication
Connected account requiredTags
Get all notification template groups.GRAFANA_ROUTE_GET_TEMPLATESGet all notification template groups.Connection
Get all notification template groups.
Authentication
Connected account requiredTags
Create a new alert rule.GRAFANA_ROUTE_POST_ALERT_RULECreate a new alert rule.Connection
Create a new alert rule.
Authentication
Connected account requiredTags
Create a contact point.GRAFANA_ROUTE_POST_CONTACTPOINTSCreate a contact point.Connection
Create a contact point.
Authentication
Connected account requiredTags
Create a new mute timing.GRAFANA_ROUTE_POST_MUTE_TIMINGCreate a new mute timing.Connection
Create a new mute timing.
Authentication
Connected account requiredTags
Update an existing alert rule.GRAFANA_ROUTE_PUT_ALERT_RULEUpdate an existing alert rule.Connection
Update an existing alert rule.
Authentication
Connected account requiredTags
Create or update alert rule group.GRAFANA_ROUTE_PUT_ALERT_RULE_GROUPCreate or update alert rule group.Connection
Create or update alert rule group.
Authentication
Connected account requiredTags
Update an existing contact point.GRAFANA_ROUTE_PUT_CONTACTPOINTUpdate an existing contact point.Connection
Update an existing contact point.
Authentication
Connected account requiredTags
Replace an existing mute timing.GRAFANA_ROUTE_PUT_MUTE_TIMINGReplace an existing mute timing.Connection
Replace an existing mute timing.
Authentication
Connected account requiredTags
Sets the notification policy tree.GRAFANA_ROUTE_PUT_POLICY_TREESets the notification policy tree.Connection
Sets the notification policy tree.
Authentication
Connected account requiredTags
Updates an existing notification template group.GRAFANA_ROUTE_PUT_TEMPLATEUpdates an existing notification template group.Connection
Updates an existing notification template group.
Authentication
Connected account requiredTags
Clears the notification policy tree.GRAFANA_ROUTE_RESET_POLICY_TREEClears the notification policy tree.Connection
Clears the notification policy tree.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
SearchGRAFANA_SEARCHSearchConnection
Search
Authentication
Connected account requiredTags
List snapshots.GRAFANA_SEARCH_DASHBOARD_SNAPSHOTSList snapshots.Connection
List snapshots.
Authentication
Connected account requiredTags
Lists all devices within the last 30 daysGRAFANA_SEARCH_DEVICESLists all devices within the last 30 daysConnection
Lists all devices within the last 30 days
Authentication
Connected account requiredTags
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:*`Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Search all Organizations.GRAFANA_SEARCH_ORGSSearch all Organizations.Connection
Search all Organizations.
Authentication
Connected account requiredTags
Get playlists.GRAFANA_SEARCH_PLAYLISTSPlease refer to [new API](?api=playlist.grafana.app-v1).Connection
Please refer to [new API](?api=playlist.grafana.app-v1).
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Search for team groups with optional filtering and pagination.GRAFANA_SEARCH_TEAM_GROUPSSearch for team groups with optional filtering and pagination.Connection
Search for team groups with optional filtering and pagination.
Authentication
Connected account requiredTags
Team Search With Paging.GRAFANA_SEARCH_TEAMSTeam Search With Paging.Connection
Team Search With Paging.
Authentication
Connected account requiredTags
Get users.GRAFANA_SEARCH_USERSReturns all users that the authenticated user has permission to view, admin permission required.Connection
Returns all users that the authenticated user has permission to view, admin permission required.
Authentication
Connected account requiredTags
Get users with paging.GRAFANA_SEARCH_USERS_WITH_PAGINGGet users with paging.Connection
Get users with paging.
Authentication
Connected account requiredTags
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`.Connection
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 requiredTags
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`.Connection
Available to org admins only and with a valid license. You need to have a permission with action `reports:send`.
Authentication
Connected account requiredTags
SetDataSourceCacheConfigGRAFANA_SET_DATA_SOURCE_CACHE_CONFIGset cache config for a single data sourceConnection
set cache config for a single data source
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
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`.Connection
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 requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
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.Connection
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 requiredTags
Star a dashboard.GRAFANA_STAR_DASHBOARD_BY_UIDStars the given Dashboard for the actual user.Connection
Stars the given Dashboard for the actual user.
Authentication
Connected account requiredTags
Add star to query in query history.GRAFANA_STAR_QUERYAdds star to query in query history as specified by the UID.Connection
Adds star to query in query history as specified by the UID.
Authentication
Connected account requiredTags
Test a recording rule.GRAFANA_TEST_CREATE_RECORDING_RULETest a recording rule.Connection
Test a recording rule.
Authentication
Connected account requiredTags
Unstar a dashboard.GRAFANA_UNSTAR_DASHBOARD_BY_UIDDeletes the starring of the given Dashboard for the actual user.Connection
Deletes the starring of the given Dashboard for the actual user.
Authentication
Connected account requiredTags
Remove star to query in query history.GRAFANA_UNSTAR_QUERYRemoves star from query in query history as specified by the UID.Connection
Removes star from query in query history as specified by the UID.
Authentication
Connected account requiredTags
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.Connection
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 requiredTags
Updates a correlation.GRAFANA_UPDATE_CORRELATIONUpdates a correlation.Connection
Updates a correlation.
Authentication
Connected account requiredTags
Update current Organization.GRAFANA_UPDATE_CURRENT_ORGUpdate current Organization.Connection
Update current Organization.
Authentication
Connected account requiredTags
Update current Organization's address.GRAFANA_UPDATE_CURRENT_ORG_ADDRESSUpdate current Organization's address.Connection
Update current Organization's address.
Authentication
Connected account requiredTags
Updates permissions for a dashboard.GRAFANA_UPDATE_DASHBOARD_PERMISSIONS_BY_UIDThis operation will remove existing permissions if they’re not included in the request.Connection
This operation will remove existing permissions if they’re not included in the request.
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
Update folder.GRAFANA_UPDATE_FOLDERUse: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}Connection
Use: /apis/folder.grafana.app/v1/namespaces/{ns}/folders/{folder_uid}
Authentication
Connected account requiredTags
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.Connection
Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.
Authentication
Connected account requiredTags
Update library element.GRAFANA_UPDATE_LIBRARY_ELEMENTUpdates an existing library element identified by uid.Connection
Updates an existing library element identified by uid.
Authentication
Connected account requiredTags
Update Organization.GRAFANA_UPDATE_ORGUpdate Organization.Connection
Update Organization.
Authentication
Connected account requiredTags
Update Organization's address.GRAFANA_UPDATE_ORG_ADDRESSUpdate Organization's address.Connection
Update Organization's address.
Authentication
Connected account requiredTags
Update Current Org Prefs.GRAFANA_UPDATE_ORG_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespaceConnection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/namespace
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
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:*`.Connection
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 requiredTags
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:*`.Connection
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 requiredTags
Update playlist.GRAFANA_UPDATE_PLAYLISTPlease refer to [new API](?api=playlist.grafana.app-v1).Connection
Please refer to [new API](?api=playlist.grafana.app-v1).
Authentication
Connected account requiredTags
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>:*`.Connection
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 requiredTags
UpdatePublicDashboardGRAFANA_UPDATE_PUBLIC_DASHBOARDUpdate public dashboard for a dashboardConnection
Update public dashboard for a dashboard
Authentication
Connected account requiredTags
Update the active status of a rule.GRAFANA_UPDATE_RECORDING_RULEUpdate the active status of a rule.Connection
Update the active status of a rule.
Authentication
Connected account requiredTags
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/Connection
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 requiredTags
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.Connection
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 requiredTags
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)Connection
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 requiredTags
Update signed in User.GRAFANA_UPDATE_SIGNED_IN_USERUpdate signed in User.Connection
Update signed in User.
Authentication
Connected account requiredTags
Update Team.GRAFANA_UPDATE_TEAMUpdate Team.Connection
Update Team.
Authentication
Connected account requiredTags
Updates LBAC rules for a team.GRAFANA_UPDATE_TEAM_LBACRULES_APIUpdates LBAC rules for a team.Connection
Updates LBAC rules for a team.
Authentication
Connected account requiredTags
Update Team Member.GRAFANA_UPDATE_TEAM_MEMBERUpdate Team Member.Connection
Update Team Member.
Authentication
Connected account requiredTags
Update Team Preferences.GRAFANA_UPDATE_TEAM_PREFERENCESUpdate Team Preferences.Connection
Update Team Preferences.
Authentication
Connected account requiredTags
Update user.GRAFANA_UPDATE_USERUpdate the user identified by id.Connection
Update the user identified by id.
Authentication
Connected account requiredTags
Update user email.GRAFANA_UPDATE_USER_EMAILUpdate the email of user given a verification code.Connection
Update the email of user given a verification code.
Authentication
Connected account requiredTags
Update user preferences.GRAFANA_UPDATE_USER_PREFERENCESUse /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}Connection
Use /apis/preferences.grafana.app/v1/namespaces/{namespace}/preferences/user-{uid}
Authentication
Connected account requiredTags
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).Connection
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 requiredTags
Upload a snapshot to the Grafana Migration Service for processing.GRAFANA_UPLOAD_SNAPSHOTUpload a snapshot to the Grafana Migration Service for processing.Connection
Upload a snapshot to the Grafana Migration Service for processing.
Authentication
Connected account requiredTags
Switch user context for signed in user.GRAFANA_USER_SET_USING_ORGSwitch user context to the given organization.Connection
Switch user context to the given organization.
Authentication
Connected account requiredTags
ViewPublicDashboardGRAFANA_VIEW_PUBLIC_DASHBOARDGet public dashboard for viewConnection
Get public dashboard for view
Authentication
Connected account requiredTags