# Module `grafana_http_api`
## Source
- Backend: `openapi3`
- Default hostname: `localhost:3000`
- Repository: https://github.com/grafana/grafana
- Pinned tag: `d18e58d33aa8741f08fbab4aa73bdaf1f04e3be5`
- Files: `packages/grafana-openapi/src/api/openapi3.json`
- Resolved SHA: `d18e58d33aa8741f08fbab4aa73bdaf1f04e3be5`
## access_control
### `grafana grafana_http_api access_control add-team-role`
- Summary: Add team role.
- HTTP: `POST /access-control/teams/{teamId}/roles`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team-id` (path, required, int64): teamId
### `grafana grafana_http_api access_control add-user-role`
- Summary: Add a user role assignment.
- HTTP: `POST /access-control/users/{userId}/roles`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user-id` (path, required, int64): userId
### `grafana grafana_http_api access_control create-role`
- Summary: Create a new custom role.
- HTTP: `POST /access-control/roles`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api access_control delete-role`
- Summary: Delete a custom role.
- HTTP: `DELETE /access-control/roles/{roleUID}`
- Auth: required
- Body: none
- Flags:
- `--force` (query): force
- `--global` (query): global
- `--role-uid` (path, required): roleUID
### `grafana grafana_http_api access_control get-access-control-status`
- Summary: Get status.
- HTTP: `GET /access-control/status`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api access_control get-resource-description`
- Summary: Get a description of a resource's access control properties.
- HTTP: `GET /access-control/{resource}/description`
- Auth: required
- Body: none
- Flags:
- `--resource` (path, required): resource
### `grafana grafana_http_api access_control get-resource-permissions`
- Summary: Get permissions for a resource.
- HTTP: `GET /access-control/{resource}/{resourceID}`
- Auth: required
- Body: none
- Flags:
- `--resource` (path, required): resource
- `--resource-id` (path, required): resourceID
### `grafana grafana_http_api access_control get-role`
- Summary: Get a role.
- HTTP: `GET /access-control/roles/{roleUID}`
- Auth: required
- Body: none
- Flags:
- `--role-uid` (path, required): roleUID
### `grafana grafana_http_api access_control get-role-assignments`
- Summary: Get role assignments.
- HTTP: `GET /access-control/roles/{roleUID}/assignments`
- Auth: required
- Body: none
- Flags:
- `--role-uid` (path, required): roleUID
### `grafana grafana_http_api access_control list-roles`
- Summary: Get all roles.
- HTTP: `GET /access-control/roles`
- Auth: required
- Body: none
- Flags:
- `--delegatable` (query): delegatable
- `--include-hidden` (query): includeHidden
- `--target-org-id` (query, int64): targetOrgId
### `grafana grafana_http_api access_control list-team-roles`
- Summary: Get team roles.
- HTTP: `GET /access-control/teams/{teamId}/roles`
- Auth: required
- Body: none
- Flags:
- `--team-id` (path, required, int64): teamId
- `--target-org-id` (query, int64): targetOrgId
### `grafana grafana_http_api access_control list-teams-roles`
- Summary: List roles assigned to multiple teams.
- HTTP: `POST /access-control/teams/roles/search`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api access_control list-user-roles`
- Summary: List roles assigned to a user.
- HTTP: `GET /access-control/users/{userId}/roles`
- Auth: required
- Body: none
- Flags:
- `--user-id` (path, required, int64): userId
- `--include-hidden` (query): includeHidden
- `--target-org-id` (query, int64): targetOrgId
### `grafana grafana_http_api access_control list-users-roles`
- Summary: List roles assigned to multiple users.
- HTTP: `POST /access-control/users/roles/search`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api access_control remove-team-role`
- Summary: Remove team role.
- HTTP: `DELETE /access-control/teams/{teamId}/roles/{roleUID}`
- Auth: required
- Body: none
- Flags:
- `--role-uid` (path, required): roleUID
- `--team-id` (path, required, int64): teamId
### `grafana grafana_http_api access_control remove-user-role`
- Summary: Remove a user role assignment.
- HTTP: `DELETE /access-control/users/{userId}/roles/{roleUID}`
- Auth: required
- Body: none
- Flags:
- `--global` (query): A flag indicating if the assignment is global or not. If set to false, the default org ID of the authenticated user will be used from the request to remove assignment.
- `--role-uid` (path, required): roleUID
- `--user-id` (path, required, int64): userId
### `grafana grafana_http_api access_control set-resource-permissions`
- Summary: Set resource permissions.
- HTTP: `POST /access-control/{resource}/{resourceID}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--resource` (path, required): resource
- `--resource-id` (path, required): resourceID
### `grafana grafana_http_api access_control set-resource-permissions-for-built-in-role`
- Summary: Set resource permissions for a built-in role.
- HTTP: `POST /access-control/{resource}/{resourceID}/builtInRoles/{builtInRole}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--resource` (path, required): resource
- `--resource-id` (path, required): resourceID
- `--built-in-role` (path, required): builtInRole
### `grafana grafana_http_api access_control set-resource-permissions-for-team`
- Summary: Set resource permissions for a team.
- HTTP: `POST /access-control/{resource}/{resourceID}/teams/{teamID}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--resource` (path, required): resource
- `--resource-id` (path, required): resourceID
- `--team-id` (path, required, int64): teamID
### `grafana grafana_http_api access_control set-resource-permissions-for-user`
- Summary: Set resource permissions for a user.
- HTTP: `POST /access-control/{resource}/{resourceID}/users/{userID}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--resource` (path, required): resource
- `--resource-id` (path, required): resourceID
- `--user-id` (path, required, int64): userID
### `grafana grafana_http_api access_control set-role-assignments`
- Summary: Set role assignments.
- HTTP: `PUT /access-control/roles/{roleUID}/assignments`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--role-uid` (path, required): roleUID
### `grafana grafana_http_api access_control set-team-roles`
- Summary: Update team role.
- HTTP: `PUT /access-control/teams/{teamId}/roles`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team-id` (path, required, int64): teamId
- `--target-org-id` (query, int64): targetOrgId
### `grafana grafana_http_api access_control set-user-roles`
- Summary: Set user role assignments.
- HTTP: `PUT /access-control/users/{userId}/roles`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user-id` (path, required, int64): userId
- `--target-org-id` (query, int64): targetOrgId
### `grafana grafana_http_api access_control update-role`
- Summary: Update a custom role.
- HTTP: `PUT /access-control/roles/{roleUID}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--role-uid` (path, required): roleUID
## admin
### `grafana grafana_http_api admin admin-get-settings`
- Summary: Fetch settings.
- HTTP: `GET /admin/settings`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin admin-get-stats`
- Summary: Fetch Grafana Stats.
- HTTP: `GET /admin/stats`
- Auth: required
- Body: none
- Flags: none
## admin_ldap
### `grafana grafana_http_api admin_ldap get-ldap-status`
- Summary: Attempts to connect to all the configured LDAP servers and returns information on whenever they're available or not.
- HTTP: `GET /admin/ldap/status`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin_ldap get-sync-status`
- Summary: Returns the current state of the LDAP background sync integration.
- HTTP: `GET /admin/ldap-sync-status`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin_ldap get-user-from-ldap`
- Summary: Finds an user based on a username in LDAP. This helps illustrate how would the particular user be mapped in Grafana when synced.
- HTTP: `GET /admin/ldap/{user_name}`
- Auth: required
- Body: none
- Flags:
- `--user_name` (path, required): user_name
### `grafana grafana_http_api admin_ldap post-sync-user-with-ldap`
- Summary: Enables a single Grafana user to be synchronized against LDAP.
- HTTP: `POST /admin/ldap/sync/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_ldap reload-ldap-cfg`
- Summary: Reloads the LDAP configuration.
- HTTP: `POST /admin/ldap/reload`
- Auth: required
- Body: none
- Flags: none
## admin_provisioning
### `grafana grafana_http_api admin_provisioning admin-provisioning-reload-access-control`
- Summary: You need to have a permission with action `provisioning:reload` with scope `provisioners:accesscontrol`.
- HTTP: `POST /admin/provisioning/access-control/reload`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin_provisioning admin-provisioning-reload-dashboards`
- Summary: Reload dashboard provisioning configurations.
- HTTP: `POST /admin/provisioning/dashboards/reload`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin_provisioning admin-provisioning-reload-datasources`
- Summary: Reload datasource provisioning configurations.
- HTTP: `POST /admin/provisioning/datasources/reload`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api admin_provisioning admin-provisioning-reload-plugins`
- Summary: Reload plugin provisioning configurations.
- HTTP: `POST /admin/provisioning/plugins/reload`
- Auth: required
- Body: none
- Flags: none
## admin_users
### `grafana grafana_http_api admin_users admin-create-user`
- Summary: Create new user.
- HTTP: `POST /admin/users`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api admin_users admin-delete-user`
- Summary: Delete global User.
- HTTP: `DELETE /admin/users/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-disable-user`
- Summary: Disable user.
- HTTP: `POST /admin/users/{user_id}/disable`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-enable-user`
- Summary: Enable user.
- HTTP: `POST /admin/users/{user_id}/enable`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-get-user-auth-tokens`
- Summary: Return a list of all auth tokens (devices) that the user currently have logged in from.
- HTTP: `GET /admin/users/{user_id}/auth-tokens`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-logout-user`
- Summary: 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.
- HTTP: `POST /admin/users/{user_id}/logout`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-revoke-user-auth-token`
- Summary: Revoke auth token for user.
- HTTP: `POST /admin/users/{user_id}/revoke-auth-token`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-update-user-password`
- Summary: Set password for user.
- HTTP: `PUT /admin/users/{user_id}/password`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api admin_users admin-update-user-permissions`
- Summary: Set permissions for user.
- HTTP: `PUT /admin/users/{user_id}/permissions`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user_id` (path, required, int64): user_id
## annotations
### `grafana grafana_http_api annotations delete-annotation-by-id`
- Summary: Delete Annotation By ID.
- HTTP: `DELETE /annotations/{annotation_id}`
- Auth: required
- Body: none
- Flags:
- `--annotation_id` (path, required): annotation_id
### `grafana grafana_http_api annotations get-annotation-by-id`
- Summary: Get Annotation by ID.
- HTTP: `GET /annotations/{annotation_id}`
- Auth: required
- Body: none
- Flags:
- `--annotation_id` (path, required): annotation_id
### `grafana grafana_http_api annotations get-annotation-tags`
- Summary: Find Annotations Tags.
- HTTP: `GET /annotations/tags`
- Auth: required
- Body: none
- Flags:
- `--tag` (query): Tag is a string that you can use to filter tags.
- `--limit` (query, default `100`): Max limit for results returned.
- Output: pagination `cursor`
### `grafana grafana_http_api annotations get-annotations`
- Summary: Find Annotations.
- HTTP: `GET /annotations`
- Auth: required
- Body: none
- Flags:
- `--from` (query, int64): Find annotations created after specific epoch datetime in milliseconds.
- `--to` (query, int64): Find annotations created before specific epoch datetime in milliseconds.
- `--user-id` (query, int64): Limit response to annotations created by specific user.
- `--user-uid` (query): Limit response to annotations created by a specific user, identified by UID.
- `--alert-id` (query, int64): Find annotations for a specified alert rule by its ID.
- `--alert-uid` (query): Find annotations for a specified alert rule by its UID.
- `--dashboard-id` (query, int64): Find annotations that are scoped to a specific dashboard
- `--dashboard-uid` (query): Find annotations that are scoped to a specific dashboard
- `--panel-id` (query, int64): Find annotations that are scoped to a specific panel
- `--limit` (query, int64): Max limit for results returned.
- `--tags` (query): Use this to filter organization annotations. Organization annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. You can filter by multiple tags.
- `--type` (query, one of: alert|annotation): Return alerts or user created annotations
- `--match-any` (query): Match any or all tags
- Output: pagination `cursor`
### `grafana grafana_http_api annotations mass-delete-annotations`
- Summary: Delete multiple annotations.
- HTTP: `POST /annotations/mass-delete`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api annotations patch-annotation`
- Summary: Patch Annotation.
- HTTP: `PATCH /annotations/{annotation_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--annotation_id` (path, required): annotation_id
### `grafana grafana_http_api annotations post-annotation`
- Summary: Create Annotation.
- HTTP: `POST /annotations`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api annotations post-graphite-annotation`
- Summary: Create Annotation in Graphite format.
- HTTP: `POST /annotations/graphite`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api annotations update-annotation`
- Summary: Update Annotation.
- HTTP: `PUT /annotations/{annotation_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--annotation_id` (path, required): annotation_id
## convert_prometheus
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-delete-namespace`
- Summary: Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.
- HTTP: `DELETE /convert/api/prom/rules/{NamespaceTitle}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-delete-rule-group`
- Summary: Deletes a specific rule group if it was imported from a Prometheus-compatible source.
- HTTP: `DELETE /convert/api/prom/rules/{NamespaceTitle}/{Group}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--group` (path, required): Group
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-get-namespace`
- Summary: Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).
- HTTP: `GET /convert/api/prom/rules/{NamespaceTitle}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- Output: response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-get-rule-group`
- Summary: Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.
- HTTP: `GET /convert/api/prom/rules/{NamespaceTitle}/{Group}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--group` (path, required): Group
- Output: list path `rules`; columns `alert`, `expr`, `for`, `keep_firing_for`, `record`; response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-get-rules`
- Summary: Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.
- HTTP: `GET /convert/api/prom/rules`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-post-rule-group`
- Summary: Converts a Prometheus rule group into a Grafana rule group and creates or updates it within the specified namespace.
- HTTP: `POST /convert/api/prom/rules/{NamespaceTitle}`
- Auth: required
- Body: optional; media type `application/yaml`
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--x-grafana-alerting-datasource-uid` (header): x-grafana-alerting-datasource-uid
- `--x-grafana-alerting-recording-rules-paused` (header): x-grafana-alerting-recording-rules-paused
- `--x-grafana-alerting-alert-rules-paused` (header): x-grafana-alerting-alert-rules-paused
- `--x-grafana-alerting-target-datasource-uid` (header): x-grafana-alerting-target-datasource-uid
- `--x-grafana-alerting-folder-uid` (header): x-grafana-alerting-folder-uid
- `--x-grafana-alerting-notification-settings` (header): x-grafana-alerting-notification-settings
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-cortex-post-rule-groups`
- Summary: Converts the submitted rule groups into Grafana-Managed Rules.
- HTTP: `POST /convert/api/prom/rules`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-delete-namespace`
- Summary: Deletes all rule groups that were imported from Prometheus-compatible sources within the specified namespace.
- HTTP: `DELETE /convert/prometheus/config/v1/rules/{NamespaceTitle}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-delete-rule-group`
- Summary: Deletes a specific rule group if it was imported from a Prometheus-compatible source.
- HTTP: `DELETE /convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--group` (path, required): Group
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-get-namespace`
- Summary: Gets Grafana-managed alert rules that were imported from Prometheus-compatible sources for a specified namespace (folder).
- HTTP: `GET /convert/prometheus/config/v1/rules/{NamespaceTitle}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- Output: response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-get-rule-group`
- Summary: Gets a single rule group in Prometheus-compatible format if it was imported from a Prometheus-compatible source.
- HTTP: `GET /convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}`
- Auth: required
- Body: none
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--group` (path, required): Group
- Output: list path `rules`; columns `alert`, `expr`, `for`, `keep_firing_for`, `record`; response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-get-rules`
- Summary: Gets all Grafana-managed alert rules that were imported from Prometheus-compatible sources, grouped by namespace.
- HTTP: `GET /convert/prometheus/config/v1/rules`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/yaml`
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-post-rule-group`
- Summary: Converts a Prometheus rule group into a Grafana rule group and creates or updates it within the specified namespace.
- HTTP: `POST /convert/prometheus/config/v1/rules/{NamespaceTitle}`
- Auth: required
- Body: optional; media type `application/yaml`
- Flags:
- `--namespace-title` (path, required): NamespaceTitle
- `--x-grafana-alerting-datasource-uid` (header): x-grafana-alerting-datasource-uid
- `--x-grafana-alerting-recording-rules-paused` (header): x-grafana-alerting-recording-rules-paused
- `--x-grafana-alerting-alert-rules-paused` (header): x-grafana-alerting-alert-rules-paused
- `--x-grafana-alerting-target-datasource-uid` (header): x-grafana-alerting-target-datasource-uid
- `--x-grafana-alerting-folder-uid` (header): x-grafana-alerting-folder-uid
- `--x-grafana-alerting-notification-settings` (header): x-grafana-alerting-notification-settings
### `grafana grafana_http_api convert_prometheus route-convert-prometheus-post-rule-groups`
- Summary: Converts the submitted rule groups into Grafana-Managed Rules.
- HTTP: `POST /convert/prometheus/config/v1/rules`
- Auth: required
- Body: none
- Flags: none
## dashboards
### `grafana grafana_http_api dashboards create-dashboard-snapshot`
- Summary: 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.
- HTTP: `POST /snapshots`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api dashboards create-public-dashboard`
- Summary: Create public dashboard for a dashboard
- HTTP: `POST /dashboards/uid/{dashboardUid}/public-dashboards`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--dashboard-uid` (path, required): dashboardUid
### `grafana grafana_http_api dashboards delete-dashboard-by-uid`
- Summary: Delete dashboard by uid.
- HTTP: `DELETE /dashboards/uid/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards delete-dashboard-snapshot`
- Summary: Delete Snapshot by Key.
- HTTP: `DELETE /snapshots/{key}`
- Auth: required
- Body: none
- Flags:
- `--key` (path, required): key
### `grafana grafana_http_api dashboards delete-dashboard-snapshot-by-delete-key`
- Summary: Delete Snapshot by deleteKey.
- HTTP: `GET /snapshots-delete/{deleteKey}`
- Auth: required
- Body: none
- Flags:
- `--delete-key` (path, required): deleteKey
### `grafana grafana_http_api dashboards delete-public-dashboard`
- Summary: Delete public dashboard for a dashboard
- HTTP: `DELETE /dashboards/uid/{dashboardUid}/public-dashboards/{uid}`
- Auth: required
- Body: none
- Flags:
- `--dashboard-uid` (path, required): dashboardUid
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards get-dashboard-by-uid`
- Summary: Get dashboard by uid.
- HTTP: `GET /dashboards/uid/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards get-dashboard-permissions-list-by-uid`
- Summary: Gets all existing permissions for the given dashboard.
- HTTP: `GET /dashboards/uid/{uid}/permissions`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards get-dashboard-snapshot`
- Summary: Get Snapshot by Key.
- HTTP: `GET /snapshots/{key}`
- Auth: required
- Body: none
- Flags:
- `--key` (path, required): key
### `grafana grafana_http_api dashboards get-dashboard-tags`
- Summary: Get all dashboards tags of an organization.
- HTTP: `GET /dashboards/tags`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api dashboards get-dashboard-version-by-uid`
- Summary: Get a specific dashboard version using UID.
- HTTP: `GET /dashboards/uid/{uid}/versions/{DashboardVersionID}`
- Auth: required
- Body: none
- Flags:
- `--dashboard-version-id` (path, required, int64): DashboardVersionID
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards get-dashboard-versions-by-uid`
- Summary: Gets all existing versions for the dashboard using UID.
- HTTP: `GET /dashboards/uid/{uid}/versions`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
- `--limit` (query, default `0`, int64): Maximum number of results to return
- `--start` (query, default `0`, int64): Version to start from when returning queries
- Output: pagination `cursor`
### `grafana grafana_http_api dashboards get-home-dashboard`
- Summary: NOTE: the home dashboard is configured in preferences. This API will be removed in G13
- HTTP: `GET /dashboards/home`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api dashboards get-public-annotations`
- Summary: Get annotations for a public dashboard
- HTTP: `GET /public/dashboards/{accessToken}/annotations`
- Auth: required
- Body: none
- Flags:
- `--access-token` (path, required): accessToken
### `grafana grafana_http_api dashboards get-public-dashboard`
- Summary: Get public dashboard by dashboardUid
- HTTP: `GET /dashboards/uid/{dashboardUid}/public-dashboards`
- Auth: required
- Body: none
- Flags:
- `--dashboard-uid` (path, required): dashboardUid
### `grafana grafana_http_api dashboards import-dashboard`
- Summary: Import dashboard.
- HTTP: `POST /dashboards/import`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api dashboards interpolate-dashboard`
- Summary: Interpolate dashboard. This is an experimental endpoint under dashboardLibrary or suggestedDashboards feature flags and is subject to change.
- HTTP: `POST /dashboards/interpolate`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api dashboards list-public-dashboards`
- Summary: Get list of public dashboards
- HTTP: `GET /dashboards/public-dashboards`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api dashboards post-dashboard`
- Summary: Create / Update dashboard
- HTTP: `POST /dashboards/db`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api dashboards query-public-dashboard`
- Summary: Get results for a given panel on a public dashboard
- HTTP: `POST /public/dashboards/{accessToken}/panels/{panelId}/query`
- Auth: required
- Body: none
- Flags:
- `--access-token` (path, required): accessToken
- `--panel-id` (path, required, int64): panelId
### `grafana grafana_http_api dashboards restore-dashboard-version-by-uid`
- Summary: Restore a dashboard to a given dashboard version using UID.
- HTTP: `POST /dashboards/uid/{uid}/restore`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards search-dashboard-snapshots`
- Summary: List snapshots.
- HTTP: `GET /dashboard/snapshots`
- Auth: required
- Body: none
- Flags:
- `--query` (query): Search Query
- `--limit` (query, default `1000`, int64): Limit the number of returned results
- Output: pagination `cursor`
### `grafana grafana_http_api dashboards update-dashboard-permissions-by-uid`
- Summary: Updates permissions for a dashboard.
- HTTP: `POST /dashboards/uid/{uid}/permissions`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards update-public-dashboard`
- Summary: Update public dashboard for a dashboard
- HTTP: `PATCH /dashboards/uid/{dashboardUid}/public-dashboards/{uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--dashboard-uid` (path, required): dashboardUid
- `--uid` (path, required): uid
### `grafana grafana_http_api dashboards view-public-dashboard`
- Summary: Get public dashboard for view
- HTTP: `GET /public/dashboards/{accessToken}`
- Auth: required
- Body: none
- Flags:
- `--access-token` (path, required): accessToken
## datasources
### `grafana grafana_http_api datasources add-data-source`
- Summary: Create a data source.
- HTTP: `POST /datasources`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api datasources call-datasource-resource-with-uid`
- Summary: Fetch data source resources.
- HTTP: `GET /datasources/uid/{uid}/resources/{datasource_proxy_route}`
- Auth: required
- Body: none
- Flags:
- `--datasource_proxy_route` (path, required): datasource_proxy_route
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources check-datasource-health-with-uid`
- Summary: Sends a health check request to the plugin datasource identified by the UID.
- HTTP: `GET /datasources/uid/{uid}/health`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources create-correlation`
- Summary: Add correlation.
- HTTP: `POST /datasources/uid/{sourceUID}/correlations`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--source-uid` (path, required): sourceUID
### `grafana grafana_http_api datasources datasource-proxy-delete-by-ui-dcalls`
- Summary: Data source proxy DELETE calls.
- HTTP: `DELETE /datasources/proxy/uid/{uid}/{datasource_proxy_route}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
- `--datasource_proxy_route` (path, required): datasource_proxy_route
### `grafana grafana_http_api datasources datasource-proxy-get-by-ui-dcalls`
- Summary: Data source proxy GET calls.
- HTTP: `GET /datasources/proxy/uid/{uid}/{datasource_proxy_route}`
- Auth: required
- Body: none
- Flags:
- `--datasource_proxy_route` (path, required): datasource_proxy_route
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources datasource-proxy-post-by-ui-dcalls`
- Summary: Data source proxy POST calls.
- HTTP: `POST /datasources/proxy/uid/{uid}/{datasource_proxy_route}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--datasource_proxy_route` (path, required): datasource_proxy_route
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources delete-correlation`
- Summary: Delete a correlation.
- HTTP: `DELETE /datasources/uid/{uid}/correlations/{correlationUID}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
- `--correlation-uid` (path, required): correlationUID
### `grafana grafana_http_api datasources delete-data-source-by-name`
- Summary: Delete an existing data source by name. This function will be removed in the future.
- HTTP: `DELETE /datasources/name/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): name
### `grafana grafana_http_api datasources delete-data-source-by-uid`
- Summary: Delete an existing data source by UID.
- HTTP: `DELETE /datasources/uid/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources get-correlation`
- Summary: Gets a correlation.
- HTTP: `GET /datasources/uid/{sourceUID}/correlations/{correlationUID}`
- Auth: required
- Body: none
- Flags:
- `--source-uid` (path, required): sourceUID
- `--correlation-uid` (path, required): correlationUID
### `grafana grafana_http_api datasources get-correlations`
- Summary: Gets all correlations.
- HTTP: `GET /datasources/correlations`
- Auth: required
- Body: none
- Flags:
- `--limit` (query, default `100`, int64): Limit the maximum number of correlations to return per page
- `--page` (query, default `1`, int64): Page index for starting fetching correlations
- `--source-uid` (query): Source datasource UID filter to be applied to correlations
- Output: pagination `offset`
### `grafana grafana_http_api datasources get-correlations-by-source-uid`
- Summary: Gets all correlations originating from the given data source.
- HTTP: `GET /datasources/uid/{sourceUID}/correlations`
- Auth: required
- Body: none
- Flags:
- `--source-uid` (path, required): sourceUID
### `grafana grafana_http_api datasources get-data-source-by-name`
- Summary: Get a single data source by Name. This function will be removed in the future.
- HTTP: `GET /datasources/name/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): name
### `grafana grafana_http_api datasources get-data-source-by-uid`
- Summary: Get a single data source by UID.
- HTTP: `GET /datasources/uid/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api datasources get-data-source-id-by-name`
- Summary: Get data source Id by Name. This function will be removed in the future.
- HTTP: `GET /datasources/id/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): name
### `grafana grafana_http_api datasources get-data-sources`
- Summary: Get all data sources.
- HTTP: `GET /datasources`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api datasources query-metrics-with-expressions`
- Summary: DataSource query metrics with expressions.
- HTTP: `POST /ds/query`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api datasources update-correlation`
- Summary: Updates a correlation.
- HTTP: `PATCH /datasources/uid/{sourceUID}/correlations/{correlationUID}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--source-uid` (path, required): sourceUID
- `--correlation-uid` (path, required): correlationUID
### `grafana grafana_http_api datasources update-data-source-by-uid`
- Summary: Update an existing data source.
- HTTP: `PUT /datasources/uid/{uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--uid` (path, required): uid
## devices
### `grafana grafana_http_api devices list-devices`
- Summary: Lists all devices within the last 30 days
- HTTP: `GET /anonymous/devices`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api devices search-devices`
- Summary: Lists all devices within the last 30 days
- HTTP: `GET /anonymous/search`
- Auth: required
- Body: none
- Flags: none
## enterprise
### `grafana grafana_http_api enterprise clean-data-source-cache`
- Summary: clean cache for a single data source
- HTTP: `POST /datasources/{dataSourceUID}/cache/clean`
- Auth: required
- Body: none
- Flags:
- `--data-source-uid` (path, required): dataSourceUID
- Output: response media `application/json`
### `grafana grafana_http_api enterprise disable-data-source-cache`
- Summary: disable cache for a single data source
- HTTP: `POST /datasources/{dataSourceUID}/cache/disable`
- Auth: required
- Body: none
- Flags:
- `--data-source-uid` (path, required): dataSourceUID
- `--data-source-type` (query): dataSourceType
- Output: response media `application/json`
### `grafana grafana_http_api enterprise enable-data-source-cache`
- Summary: enable cache for a single data source
- HTTP: `POST /datasources/{dataSourceUID}/cache/enable`
- Auth: required
- Body: none
- Flags:
- `--data-source-uid` (path, required): dataSourceUID
- `--data-source-type` (query): dataSourceType
- Output: response media `application/json`
### `grafana grafana_http_api enterprise get-data-source-cache-config`
- Summary: get cache config for a single data source
- HTTP: `GET /datasources/{dataSourceUID}/cache`
- Auth: required
- Body: none
- Flags:
- `--data-source-uid` (path, required): dataSourceUID
- `--data-source-type` (query): dataSourceType
- Output: response media `application/json`
### `grafana grafana_http_api enterprise get-team-lbac-rules-api`
- Summary: Retrieves LBAC rules for a team.
- HTTP: `GET /datasources/uid/{uid}/lbac/teams`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api enterprise set-data-source-cache-config`
- Summary: set cache config for a single data source
- HTTP: `POST /datasources/{dataSourceUID}/cache`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--data-source-uid` (path, required): dataSourceUID
- `--data-source-type` (query): dataSourceType
- Output: response media `application/json`
### `grafana grafana_http_api enterprise update-team-lbac-rules-api`
- Summary: Updates LBAC rules for a team.
- HTTP: `PUT /datasources/uid/{uid}/lbac/teams`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--uid` (path, required): uid
## folders
### `grafana grafana_http_api folders create-folder`
- Summary: Create folder.
- HTTP: `POST /folders`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api folders delete-folder`
- Summary: Delete folder.
- HTTP: `DELETE /folders/{folder_uid}`
- Auth: required
- Body: none
- Flags:
- `--folder_uid` (path, required): folder_uid
- `--force-delete-rules` (query, default `false`): If `true` any Grafana 8 Alerts under this folder will be deleted.
### `grafana grafana_http_api folders get-folder-by-uid`
- Summary: Get folder by uid.
- HTTP: `GET /folders/{folder_uid}`
- Auth: required
- Body: none
- Flags:
- `--folder_uid` (path, required): folder_uid
### `grafana grafana_http_api folders get-folder-descendant-counts`
- Summary: Gets the count of each descendant of a folder by kind. The folder is identified by UID.
- HTTP: `GET /folders/{folder_uid}/counts`
- Auth: required
- Body: none
- Flags:
- `--folder_uid` (path, required): folder_uid
### `grafana grafana_http_api folders get-folder-permission-list`
- Summary: Gets all existing permissions for the folder with the given `uid`.
- HTTP: `GET /folders/{folder_uid}/permissions`
- Auth: required
- Body: none
- Flags:
- `--folder_uid` (path, required): folder_uid
### `grafana grafana_http_api folders get-folders`
- Summary: Get all folders.
- HTTP: `GET /folders`
- Auth: required
- Body: none
- Flags:
- `--limit` (query, default `1000`, int64): Limit the maximum number of folders to return
- `--page` (query, default `1`, int64): Page index for starting fetching folders
- `--parent-uid` (query): The parent folder UID
- `--permission` (query, default `View`, one of: Edit|View): Set to `Edit` to return folders that the user can edit
- Output: pagination `offset`
### `grafana grafana_http_api folders move-folder`
- Summary: Move folder.
- HTTP: `POST /folders/{folder_uid}/move`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--folder_uid` (path, required): folder_uid
### `grafana grafana_http_api folders update-folder`
- Summary: Update folder.
- HTTP: `PUT /folders/{folder_uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--folder_uid` (path, required): folder_uid
### `grafana grafana_http_api folders update-folder-permissions`
- Summary: Updates permissions for a folder. This operation will remove existing permissions if they’re not included in the request.
- HTTP: `POST /folders/{folder_uid}/permissions`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--folder_uid` (path, required): folder_uid
## health
### `grafana grafana_http_api health get-health`
- Summary: apiHealthHandler will return ok if Grafana's web server is running and it
- HTTP: `GET /health`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`
## library_elements
### `grafana grafana_http_api library_elements create-library-element`
- Summary: Create library element.
- HTTP: `POST /library-elements`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api library_elements delete-library-element-by-uid`
- Summary: Delete library element.
- HTTP: `DELETE /library-elements/{library_element_uid}`
- Auth: required
- Body: none
- Flags:
- `--library_element_uid` (path, required): library_element_uid
### `grafana grafana_http_api library_elements get-library-element-by-name`
- Summary: Get library element by name.
- HTTP: `GET /library-elements/name/{library_element_name}`
- Auth: required
- Body: none
- Flags:
- `--library_element_name` (path, required): library_element_name
### `grafana grafana_http_api library_elements get-library-element-by-uid`
- Summary: Get library element by UID.
- HTTP: `GET /library-elements/{library_element_uid}`
- Auth: required
- Body: none
- Flags:
- `--library_element_uid` (path, required): library_element_uid
### `grafana grafana_http_api library_elements get-library-element-connections`
- Summary: Get library element connections.
- HTTP: `GET /library-elements/{library_element_uid}/connections/`
- Auth: required
- Body: none
- Flags:
- `--library_element_uid` (path, required): library_element_uid
### `grafana grafana_http_api library_elements get-library-elements`
- Summary: Get all library elements.
- HTTP: `GET /library-elements`
- Auth: required
- Body: none
- Flags:
- `--search-string` (query): Part of the name or description searched for.
- `--kind` (query, int64, one of: 1): Kind of element to search for.
- `--sort-direction` (query, one of: alpha-asc|alpha-desc): Sort order of elements.
- `--type-filter` (query): A comma separated list of types to filter the elements by
- `--exclude-uid` (query): Element UID to exclude from search results.
- `--folder-filter` (query): A comma separated list of folder ID(s) to filter the elements by.
- `--folder-filter-ui-ds` (query): A comma separated list of folder UID(s) to filter the elements by.
- `--per-page` (query, default `100`, int64): The number of results per page.
- `--page` (query, default `1`, int64): The page for a set of records, given that only perPage records are returned at a time. Numbering starts at 1.
- Output: pagination `offset`
### `grafana grafana_http_api library_elements update-library-element`
- Summary: Update library element.
- HTTP: `PATCH /library-elements/{library_element_uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--library_element_uid` (path, required): library_element_uid
## licensing
### `grafana grafana_http_api licensing delete-license-token`
- Summary: Remove license from database.
- HTTP: `DELETE /licensing/token`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api licensing get-custom-permissions-csv`
- Summary: Get custom permissions report in CSV format.
- HTTP: `GET /licensing/custom-permissions-csv`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api licensing get-custom-permissions-report`
- Summary: Get custom permissions report.
- HTTP: `GET /licensing/custom-permissions`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api licensing get-license-token`
- Summary: Get license token.
- HTTP: `GET /licensing/token`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api licensing get-status`
- Summary: Check license availability.
- HTTP: `GET /licensing/check`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api licensing post-license-token`
- Summary: Create license token.
- HTTP: `POST /licensing/token`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api licensing post-renew-license-token`
- Summary: Manually force license refresh.
- HTTP: `POST /licensing/token/renew`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api licensing refresh-license-stats`
- Summary: Refresh license stats.
- HTTP: `GET /licensing/refresh-stats`
- Auth: required
- Body: none
- Flags: none
## migrations
### `grafana grafana_http_api migrations cancel-snapshot`
- Summary: Cancel a snapshot, wherever it is in its processing chain.
- HTTP: `POST /cloudmigration/migration/{uid}/snapshot/{snapshotUid}/cancel`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): Session UID of a session
- `--snapshot-uid` (path, required): UID of a snapshot
### `grafana grafana_http_api migrations create-cloud-migration-token`
- Summary: Create gcom access token.
- HTTP: `POST /cloudmigration/token`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api migrations create-session`
- Summary: Create a migration session.
- HTTP: `POST /cloudmigration/migration`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api migrations create-snapshot`
- Summary: Trigger the creation of an instance snapshot associated with the provided session.
- HTTP: `POST /cloudmigration/migration/{uid}/snapshot`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--uid` (path, required): UID of a session
### `grafana grafana_http_api migrations delete-cloud-migration-token`
- Summary: Deletes a cloud migration token.
- HTTP: `DELETE /cloudmigration/token/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): UID of a cloud migration token
### `grafana grafana_http_api migrations delete-session`
- Summary: Delete a migration session by its uid.
- HTTP: `DELETE /cloudmigration/migration/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): UID of a migration session
### `grafana grafana_http_api migrations get-cloud-migration-token`
- Summary: Fetch the cloud migration token if it exists.
- HTTP: `GET /cloudmigration/token`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api migrations get-resource-dependencies`
- Summary: Get the resource dependencies graph for the current set of migratable resources.
- HTTP: `GET /cloudmigration/resources/dependencies`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api migrations get-session`
- Summary: Get a cloud migration session by its uid.
- HTTP: `GET /cloudmigration/migration/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): UID of a migration session
### `grafana grafana_http_api migrations get-session-list`
- Summary: Get a list of all cloud migration sessions that have been created.
- HTTP: `GET /cloudmigration/migration`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api migrations get-shapshot-list`
- Summary: Get a list of snapshots for a session.
- HTTP: `GET /cloudmigration/migration/{uid}/snapshots`
- Auth: required
- Body: none
- Flags:
- `--page` (query, default `1`, int64): Page is used for pagination with limit
- `--limit` (query, default `100`, int64): Max limit for results returned.
- `--uid` (path, required): Session UID of a session
- `--sort` (query): Sort with value latest to return results sorted in descending order.
- Output: pagination `offset`
### `grafana grafana_http_api migrations get-snapshot`
- Summary: Get metadata about a snapshot, including where it is in its processing and final results.
- HTTP: `GET /cloudmigration/migration/{uid}/snapshot/{snapshotUid}`
- Auth: required
- Body: none
- Flags:
- `--result-page` (query, default `1`, int64): ResultPage is used for pagination with ResultLimit
- `--result-limit` (query, default `100`, int64): Max limit for snapshot results returned.
- `--result-sort-column` (query, default `default`): ResultSortColumn can be used to override the default system sort. Valid values are "name", "resource_type", and "status".
- `--result-sort-order` (query, default `ASC`): ResultSortOrder is used with ResultSortColumn. Valid values are ASC and DESC.
- `--errors-only` (query, default `false`): ErrorsOnly is used to only return resources with error statuses
- `--uid` (path, required): Session UID of a session
- `--snapshot-uid` (path, required): UID of a snapshot
### `grafana grafana_http_api migrations upload-snapshot`
- Summary: Upload a snapshot to the Grafana Migration Service for processing.
- HTTP: `POST /cloudmigration/migration/{uid}/snapshot/{snapshotUid}/upload`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): Session UID of a session
- `--snapshot-uid` (path, required): UID of a snapshot
## org
### `grafana grafana_http_api org add-org-invite`
- Summary: Add invite.
- HTTP: `POST /org/invites`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org add-org-user-to-current-org`
- Summary: Add a new user to the current organization.
- HTTP: `POST /org/users`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org get-current-org`
- Summary: Get current Organization.
- HTTP: `GET /org`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api org get-org-preferences`
- Summary: Get Current Org Prefs.
- HTTP: `GET /org/preferences`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api org get-org-users-for-current-org`
- Summary: Get all users within the current organization.
- HTTP: `GET /org/users`
- Auth: required
- Body: none
- Flags:
- `--query` (query): query
- `--limit` (query, int64): limit
- Output: pagination `cursor`
### `grafana grafana_http_api org get-org-users-for-current-org-lookup`
- Summary: Get all users within the current organization (lookup)
- HTTP: `GET /org/users/lookup`
- Auth: required
- Body: none
- Flags:
- `--query` (query): query
- `--limit` (query, int64): limit
- Output: pagination `cursor`
### `grafana grafana_http_api org get-pending-org-invites`
- Summary: Get pending invites.
- HTTP: `GET /org/invites`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api org patch-org-preferences`
- Summary: Patch Current Org Prefs.
- HTTP: `PATCH /org/preferences`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org remove-org-user-for-current-org`
- Summary: Delete user in current organization.
- HTTP: `DELETE /org/users/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api org revoke-invite`
- Summary: Revoke invite.
- HTTP: `DELETE /org/invites/{invitation_code}/revoke`
- Auth: required
- Body: none
- Flags:
- `--invitation_code` (path, required): invitation_code
### `grafana grafana_http_api org update-current-org`
- Summary: Update current Organization.
- HTTP: `PUT /org`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org update-current-org-address`
- Summary: Update current Organization's address.
- HTTP: `PUT /org/address`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org update-org-preferences`
- Summary: Update Current Org Prefs.
- HTTP: `PUT /org/preferences`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api org update-org-user-for-current-org`
- Summary: Updates the given user.
- HTTP: `PATCH /org/users/{user_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user_id` (path, required, int64): user_id
## orgs
### `grafana grafana_http_api orgs add-org-user`
- Summary: Add a new user to the current organization.
- HTTP: `POST /orgs/{org_id}/users`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs create-org`
- Summary: Create Organization.
- HTTP: `POST /orgs`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api orgs delete-org-by-id`
- Summary: Delete Organization.
- HTTP: `DELETE /orgs/{org_id}`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs get-org-by-id`
- Summary: Get Organization by ID.
- HTTP: `GET /orgs/{org_id}`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs get-org-by-name`
- Summary: Get Organization by Name.
- HTTP: `GET /orgs/name/{org_name}`
- Auth: required
- Body: none
- Flags:
- `--org_name` (path, required): org_name
### `grafana grafana_http_api orgs get-org-users`
- Summary: Get Users in Organization.
- HTTP: `GET /orgs/{org_id}/users`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs remove-org-user`
- Summary: Delete user in current organization.
- HTTP: `DELETE /orgs/{org_id}/users/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api orgs search-org-users`
- Summary: Search Users in Organization.
- HTTP: `GET /orgs/{org_id}/users/search`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs search-orgs`
- Summary: Search all Organizations.
- HTTP: `GET /orgs`
- Auth: required
- Body: none
- Flags:
- `--page` (query, default `1`, int64): page
- `--perpage` (query, default `1000`, int64): Number of items per page
- `--name` (query): name
- `--query` (query): If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded.
- Output: pagination `offset`
### `grafana grafana_http_api orgs update-org`
- Summary: Update Organization.
- HTTP: `PUT /orgs/{org_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs update-org-address`
- Summary: Update Organization's address.
- HTTP: `PUT /orgs/{org_id}/address`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api orgs update-org-user`
- Summary: Update Users in Organization.
- HTTP: `PATCH /orgs/{org_id}/users/{user_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--org_id` (path, required, int64): org_id
- `--user_id` (path, required, int64): user_id
## playlists
### `grafana grafana_http_api playlists create-playlist`
- Summary: Create playlist.
- HTTP: `POST /playlists`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api playlists delete-playlist`
- Summary: Delete playlist.
- HTTP: `DELETE /playlists/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api playlists get-playlist`
- Summary: Get playlist.
- HTTP: `GET /playlists/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api playlists get-playlist-items`
- Summary: Get playlist items.
- HTTP: `GET /playlists/{uid}/items`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api playlists search-playlists`
- Summary: Get playlists.
- HTTP: `GET /playlists`
- Auth: required
- Body: none
- Flags:
- `--query` (query): query
- `--limit` (query, int64): in:limit
- Output: pagination `cursor`
### `grafana grafana_http_api playlists update-playlist`
- Summary: Update playlist.
- HTTP: `PUT /playlists/{uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--uid` (path, required): uid
## provisioning
### `grafana grafana_http_api provisioning route-delete-alert-rule`
- Summary: Delete a specific alert rule by UID.
- HTTP: `DELETE /v1/provisioning/alert-rules/{UID}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): Alert rule UID
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-delete-alert-rule-group`
- Summary: Delete rule group
- HTTP: `DELETE /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}`
- Auth: required
- Body: none
- Flags:
- `--folder-uid` (path, required): FolderUID
- `--group` (path, required): Group
### `grafana grafana_http_api provisioning route-delete-contactpoints`
- Summary: Delete a contact point.
- HTTP: `DELETE /v1/provisioning/contact-points/{UID}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): UID is the contact point unique identifier
### `grafana grafana_http_api provisioning route-delete-mute-timing`
- Summary: Delete a mute timing.
- HTTP: `DELETE /v1/provisioning/mute-timings/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): Mute timing name
- `--version` (query): Version of mute timing to use for optimistic concurrency. Leave empty to disable validation
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-delete-template`
- Summary: Delete a notification template group.
- HTTP: `DELETE /v1/provisioning/templates/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): Template group name
- `--version` (query): Version of template to use for optimistic concurrency. Leave empty to disable validation
### `grafana grafana_http_api provisioning route-export-mute-timing`
- Summary: Export a mute timing in provisioning format.
- HTTP: `GET /v1/provisioning/mute-timings/{name}/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- `--name` (path, required): Mute timing name
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-export-mute-timings`
- Summary: Export all mute timings in provisioning format.
- HTTP: `GET /v1/provisioning/mute-timings/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rule`
- Summary: Get a specific alert rule by UID.
- HTTP: `GET /v1/provisioning/alert-rules/{UID}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): Alert rule UID
- Output: list path `data`; columns `datasourceUid`, `queryType`, `refId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rule-export`
- Summary: Export an alert rule in provisioning file format.
- HTTP: `GET /v1/provisioning/alert-rules/{UID}/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- `--uid` (path, required): Alert rule UID
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rule-group`
- Summary: Get a rule group.
- HTTP: `GET /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}`
- Auth: required
- Body: none
- Flags:
- `--folder-uid` (path, required): FolderUID
- `--group` (path, required): Group
- Output: list path `rules`; columns `id`, `uid`, `condition`, `execErrState`, `folderUID`, `for`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rule-group-export`
- Summary: Export an alert rule group in provisioning file format.
- HTTP: `GET /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- `--folder-uid` (path, required): FolderUID
- `--group` (path, required): Group
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rules`
- Summary: Get all the alert rules.
- HTTP: `GET /v1/provisioning/alert-rules`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `uid`, `condition`, `execErrState`, `folderUID`, `for`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-alert-rules-export`
- Summary: Export all alert rules in provisioning file format.
- HTTP: `GET /v1/provisioning/alert-rules/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- `--folder-uid` (query): UIDs of folders from which to export rules
- `--group` (query): Name of group of rules to export. Must be specified only together with a single folder UID
- `--rule-uid` (query): UID of alert rule to export. If specified, parameters folderUid and group must be empty.
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-contactpoints`
- Summary: Get all the contact points.
- HTTP: `GET /v1/provisioning/contact-points`
- Auth: required
- Body: none
- Flags:
- `--name` (query): Filter by name
- Output: columns `name`, `type`, `uid`, `disableResolveMessage`, `provenance`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-contactpoints-export`
- Summary: Export all contact points in provisioning file format.
- HTTP: `GET /v1/provisioning/contact-points/export`
- Auth: required
- Body: none
- Flags:
- `--download` (query, default `false`): Whether to initiate a download of the file or not.
- `--format` (query, default `yaml`, one of: yaml|json|hcl): Format of the downloaded file. Supported yaml, json or hcl. Accept header can also be used, but the query parameter will take precedence.
- `--decrypt` (query, default `false`): Whether any contained secure settings should be decrypted or left redacted. Redacted settings will contain RedactedValue instead. Currently, only org admin can view decrypted secure settings.
- `--name` (query): Filter by name
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-mute-timing`
- Summary: Get a mute timing.
- HTTP: `GET /v1/provisioning/mute-timings/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): Mute timing name
- Output: list path `time_intervals`; columns `name`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-mute-timings`
- Summary: Get all the mute timings.
- HTTP: `GET /v1/provisioning/mute-timings`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-policy-tree`
- Summary: Get the notification policy tree.
- HTTP: `GET /v1/provisioning/policies`
- Auth: required
- Body: none
- Flags: none
- Output: list path `active_time_intervals`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-policy-tree-export`
- Summary: Export the notification policy tree in provisioning file format.
- HTTP: `GET /v1/provisioning/policies/export`
- Auth: required
- Body: none
- Flags: none
- Output: list path `contactPoints`; columns `name`, `orgId`; response media `application/json`
### `grafana grafana_http_api provisioning route-get-template`
- Summary: Get a notification template group.
- HTTP: `GET /v1/provisioning/templates/{name}`
- Auth: required
- Body: none
- Flags:
- `--name` (path, required): Template group name
- Output: response media `application/json`
### `grafana grafana_http_api provisioning route-get-templates`
- Summary: Get all notification template groups.
- HTTP: `GET /v1/provisioning/templates`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `provenance`, `template`, `version`; response media `application/json`
### `grafana grafana_http_api provisioning route-post-alert-rule`
- Summary: Create a new alert rule.
- HTTP: `POST /v1/provisioning/alert-rules`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-post-contactpoints`
- Summary: Create a contact point.
- HTTP: `POST /v1/provisioning/contact-points`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-post-mute-timing`
- Summary: Create a new mute timing.
- HTTP: `POST /v1/provisioning/mute-timings`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-put-alert-rule`
- Summary: Update an existing alert rule.
- HTTP: `PUT /v1/provisioning/alert-rules/{UID}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--uid` (path, required): Alert rule UID
- `--x-disable-provenance` (header): X-Disable-Provenance
- Output: list path `data`; columns `datasourceUid`, `queryType`, `refId`; response media `application/json`
### `grafana grafana_http_api provisioning route-put-alert-rule-group`
- Summary: Create or update alert rule group.
- HTTP: `PUT /v1/provisioning/folder/{FolderUID}/rule-groups/{Group}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--x-disable-provenance` (header): X-Disable-Provenance
- `--folder-uid` (path, required): FolderUID
- `--group` (path, required): Group
- Output: list path `rules`; columns `id`, `uid`, `condition`, `execErrState`, `folderUID`, `for`; response media `application/json`
### `grafana grafana_http_api provisioning route-put-contactpoint`
- Summary: Update an existing contact point.
- HTTP: `PUT /v1/provisioning/contact-points/{UID}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--uid` (path, required): UID is the contact point unique identifier
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-put-mute-timing`
- Summary: Replace an existing mute timing.
- HTTP: `PUT /v1/provisioning/mute-timings/{name}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--name` (path, required): Mute timing name
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-put-policy-tree`
- Summary: Sets the notification policy tree.
- HTTP: `PUT /v1/provisioning/policies`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-put-template`
- Summary: Updates an existing notification template group.
- HTTP: `PUT /v1/provisioning/templates/{name}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--name` (path, required): Template group name
- `--x-disable-provenance` (header): X-Disable-Provenance
### `grafana grafana_http_api provisioning route-reset-policy-tree`
- Summary: Clears the notification policy tree.
- HTTP: `DELETE /v1/provisioning/policies`
- Auth: required
- Body: none
- Flags: none
## query_history
### `grafana grafana_http_api query_history create-query`
- Summary: Add query to query history.
- HTTP: `POST /query-history`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api query_history delete-query`
- Summary: Delete query in query history.
- HTTP: `DELETE /query-history/{query_history_uid}`
- Auth: required
- Body: none
- Flags:
- `--query_history_uid` (path, required): query_history_uid
### `grafana grafana_http_api query_history patch-query-comment`
- Summary: Update comment for query in query history.
- HTTP: `PATCH /query-history/{query_history_uid}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--query_history_uid` (path, required): query_history_uid
### `grafana grafana_http_api query_history search-queries`
- Summary: Query history search.
- HTTP: `GET /query-history`
- Auth: required
- Body: none
- Flags:
- `--datasource-uid` (query): List of data source UIDs to search for
- `--search-string` (query): Text inside query or comments that is searched for
- `--only-starred` (query): Flag indicating if only starred queries should be returned
- `--sort` (query, default `time-desc`, one of: time-desc|time-asc): Sort method
- `--page` (query, int64): Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size.
- `--limit` (query, int64): Limit the number of returned results
- `--from` (query, int64): From range for the query history search
- `--to` (query, int64): To range for the query history search
- Output: pagination `offset`
### `grafana grafana_http_api query_history star-query`
- Summary: Add star to query in query history.
- HTTP: `POST /query-history/star/{query_history_uid}`
- Auth: required
- Body: none
- Flags:
- `--query_history_uid` (path, required): query_history_uid
### `grafana grafana_http_api query_history unstar-query`
- Summary: Remove star to query in query history.
- HTTP: `DELETE /query-history/star/{query_history_uid}`
- Auth: required
- Body: none
- Flags:
- `--query_history_uid` (path, required): query_history_uid
## quota
### `grafana grafana_http_api quota get-current-org-quota`
- Summary: Fetch Organization quota.
- HTTP: `GET /org/quotas`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api quota get-org-quota`
- Summary: Fetch Organization quota.
- HTTP: `GET /orgs/{org_id}/quotas`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api quota get-user-quota`
- Summary: Fetch user quota.
- HTTP: `GET /admin/users/{user_id}/quotas`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api quota get-user-quotas`
- Summary: Fetch user quota.
- HTTP: `GET /user/quotas`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api quota update-org-quota`
- Summary: Update user quota.
- HTTP: `PUT /orgs/{org_id}/quotas/{quota_target}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--quota_target` (path, required): quota_target
- `--org_id` (path, required, int64): org_id
### `grafana grafana_http_api quota update-user-quota`
- Summary: Update user quota.
- HTTP: `PUT /admin/users/{user_id}/quotas/{quota_target}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--quota_target` (path, required): quota_target
- `--user_id` (path, required, int64): user_id
## recording_rules
### `grafana grafana_http_api recording_rules create-recording-rule`
- Summary: Create a recording rule that is then registered and started.
- HTTP: `POST /recording-rules`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api recording_rules create-recording-rule-write-target`
- Summary: Create a remote write target.
- HTTP: `POST /recording-rules/writer`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api recording_rules delete-recording-rule`
- Summary: Delete removes the rule from the registry and stops it.
- HTTP: `DELETE /recording-rules/{recordingRuleID}`
- Auth: required
- Body: none
- Flags:
- `--recording-rule-id` (path, required, int64): recordingRuleID
### `grafana grafana_http_api recording_rules delete-recording-rule-write-target`
- Summary: Delete the remote write target.
- HTTP: `DELETE /recording-rules/writer`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api recording_rules get-recording-rule-write-target`
- Summary: Return the prometheus remote write target.
- HTTP: `GET /recording-rules/writer`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api recording_rules list-recording-rules`
- Summary: Lists all rules in the database: active or deleted.
- HTTP: `GET /recording-rules`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api recording_rules test-create-recording-rule`
- Summary: Test a recording rule.
- HTTP: `POST /recording-rules/test`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api recording_rules update-recording-rule`
- Summary: Update the active status of a rule.
- HTTP: `PUT /recording-rules`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
## reports
### `grafana grafana_http_api reports create-report`
- Summary: Create a report.
- HTTP: `POST /reports`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api reports delete-report`
- Summary: Delete a report.
- HTTP: `DELETE /reports/{id}`
- Auth: required
- Body: none
- Flags:
- `--id` (path, required, int64): id
### `grafana grafana_http_api reports get-report`
- Summary: Get a report.
- HTTP: `GET /reports/{id}`
- Auth: required
- Body: none
- Flags:
- `--id` (path, required, int64): id
### `grafana grafana_http_api reports get-report-settings`
- Summary: Get report settings.
- HTTP: `GET /reports/settings`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api reports get-reports`
- Summary: List reports.
- HTTP: `GET /reports`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api reports get-reports-by-dashboard-uid`
- Summary: List reports by dashboard uid.
- HTTP: `GET /reports/dashboards/{uid}`
- Auth: required
- Body: none
- Flags:
- `--uid` (path, required): uid
### `grafana grafana_http_api reports get-settings-image`
- Summary: Get custom branding report image.
- HTTP: `GET /reports/images/:image`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api reports render-report-cs-vs`
- Summary: Download a CSV report.
- HTTP: `GET /reports/render/csvs`
- Auth: required
- Body: none
- Flags:
- `--dashboards` (query): dashboards
- `--title` (query): title
### `grafana grafana_http_api reports render-report-pd-fs`
- Summary: Render report for multiple dashboards.
- HTTP: `GET /reports/render/pdfs`
- Auth: required
- Body: none
- Flags:
- `--dashboards` (query): dashboards
- `--orientation` (query): orientation
- `--layout` (query): layout
- `--title` (query): title
- `--scale-factor` (query): scaleFactor
- `--include-tables` (query): includeTables
### `grafana grafana_http_api reports save-report-settings`
- Summary: Save settings.
- HTTP: `POST /reports/settings`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api reports send-report`
- Summary: Send a report.
- HTTP: `POST /reports/email`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api reports send-test-email`
- Summary: Send test report via email.
- HTTP: `POST /reports/test-email`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api reports update-report`
- Summary: Update a report.
- HTTP: `PUT /reports/{id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--id` (path, required, int64): id
## saml
### `grafana grafana_http_api saml get-metadata`
- Summary: It exposes the SP (Grafana's) metadata for the IdP's consumption.
- HTTP: `GET /saml/metadata`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api saml get-saml-logout`
- Summary: GetLogout initiates single logout process.
- HTTP: `GET /logout/saml`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api saml get-slo`
- Summary: It performs Single Logout (SLO) callback.
- HTTP: `GET /saml/slo`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api saml post-acs`
- Summary: It performs Assertion Consumer Service (ACS).
- HTTP: `POST /saml/acs`
- Auth: required
- Body: none
- Flags:
- `--relay-state` (query): RelayState
### `grafana grafana_http_api saml post-slo`
- Summary: It performs Single Logout (SLO) callback.
- HTTP: `POST /saml/slo`
- Auth: required
- Body: none
- Flags:
- `--saml-request` (query): SAMLRequest
- `--saml-response` (query): SAMLResponse
## search
### `grafana grafana_http_api search list-sort-options`
- Summary: List search sorting options.
- HTTP: `GET /search/sorting`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api search search`
- Summary: search
- HTTP: `GET /search`
- Auth: required
- Body: none
- Flags:
- `--query` (query): Search Query
- `--tag` (query): List of tags to search for
- `--type` (query, one of: dash-folder|dash-db): Type to search for, dash-folder or dash-db
- `--dashboard-ids` (query): List of dashboard id’s to search for
- `--dashboard-ui-ds` (query): List of dashboard uid’s to search for
- `--folder-ids` (query): List of folder id’s to search in for dashboards
- `--folder-ui-ds` (query): List of folder UID’s to search in for dashboards
- `--starred` (query): Flag indicating if only starred Dashboards should be returned
- `--limit` (query, int64): Limit the number of returned results (max 5000)
- `--page` (query, int64): Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+.
- `--permission` (query, default `View`, one of: Edit|View): Set to `Edit` to return dashboards/folders that the user can edit
- `--sort` (query, default `alpha-asc`, one of: alpha-asc|alpha-desc): Sort method; for listing all the possible sort methods use the search sorting endpoint.
- `--deleted` (query): Flag indicating if only soft deleted Dashboards should be returned
- Output: pagination `offset`
## service_accounts
### `grafana grafana_http_api service_accounts create-service-account`
- Summary: Create service account
- HTTP: `POST /serviceaccounts`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
### `grafana grafana_http_api service_accounts create-token`
- Summary: CreateNewToken adds a token to a service account
- HTTP: `POST /serviceaccounts/{serviceAccountId}/tokens`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--service-account-id` (path, required, int64): serviceAccountId
### `grafana grafana_http_api service_accounts delete-service-account`
- Summary: Delete service account
- HTTP: `DELETE /serviceaccounts/{serviceAccountId}`
- Auth: required
- Body: none
- Flags:
- `--service-account-id` (path, required, int64): serviceAccountId
### `grafana grafana_http_api service_accounts delete-token`
- Summary: DeleteToken deletes service account tokens
- HTTP: `DELETE /serviceaccounts/{serviceAccountId}/tokens/{tokenId}`
- Auth: required
- Body: none
- Flags:
- `--token-id` (path, required, int64): tokenId
- `--service-account-id` (path, required, int64): serviceAccountId
### `grafana grafana_http_api service_accounts list-tokens`
- Summary: Get service account tokens
- HTTP: `GET /serviceaccounts/{serviceAccountId}/tokens`
- Auth: required
- Body: none
- Flags:
- `--service-account-id` (path, required, int64): serviceAccountId
### `grafana grafana_http_api service_accounts retrieve-service-account`
- Summary: Get single serviceaccount by Id
- HTTP: `GET /serviceaccounts/{serviceAccountId}`
- Auth: required
- Body: none
- Flags:
- `--service-account-id` (path, required, int64): serviceAccountId
### `grafana grafana_http_api service_accounts search-org-service-accounts-with-paging`
- Summary: Search service accounts with paging
- HTTP: `GET /serviceaccounts/search`
- Auth: required
- Body: none
- Flags:
- `--disabled` (query): Disabled
- `--expired-tokens` (query): expiredTokens
- `--query` (query): It will return results where the query value is contained in one of the name.
- `--perpage` (query, int64): The default value is 1000.
- `--page` (query, int64): The default value is 1.
- Output: pagination `offset`
### `grafana grafana_http_api service_accounts update-service-account`
- Summary: Update service account
- HTTP: `PATCH /serviceaccounts/{serviceAccountId}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
- `--service-account-id` (path, required, int64): serviceAccountId
## signed_in_user
### `grafana grafana_http_api signed_in_user change-user-password`
- Summary: Change Password.
- HTTP: `PUT /user/password`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api signed_in_user get-signed-in-user`
- Summary: Get (current authenticated user)
- HTTP: `GET /user`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api signed_in_user get-signed-in-user-org-list`
- Summary: Organizations of the actual User.
- HTTP: `GET /user/orgs`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api signed_in_user get-signed-in-user-team-list`
- Summary: Teams that the actual User is member of.
- HTTP: `GET /user/teams`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api signed_in_user get-user-auth-tokens`
- Summary: Auth tokens of the actual User.
- HTTP: `GET /user/auth-tokens`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api signed_in_user get-user-preferences`
- Summary: Get user preferences.
- HTTP: `GET /user/preferences`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api signed_in_user patch-user-preferences`
- Summary: Patch user preferences.
- HTTP: `PATCH /user/preferences`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api signed_in_user revoke-user-auth-token`
- Summary: Revoke an auth token of the actual User.
- HTTP: `POST /user/revoke-auth-token`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api signed_in_user star-dashboard-by-uid`
- Summary: Star a dashboard.
- HTTP: `POST /user/stars/dashboard/uid/{dashboard_uid}`
- Auth: required
- Body: none
- Flags:
- `--dashboard_uid` (path, required): dashboard_uid
### `grafana grafana_http_api signed_in_user unstar-dashboard-by-uid`
- Summary: Unstar a dashboard.
- HTTP: `DELETE /user/stars/dashboard/uid/{dashboard_uid}`
- Auth: required
- Body: none
- Flags:
- `--dashboard_uid` (path, required): dashboard_uid
### `grafana grafana_http_api signed_in_user update-signed-in-user`
- Summary: Update signed in User.
- HTTP: `PUT /user`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api signed_in_user update-user-preferences`
- Summary: Update user preferences.
- HTTP: `PUT /user/preferences`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api signed_in_user user-set-using-org`
- Summary: Switch user context for signed in user.
- HTTP: `POST /user/using/{org_id}`
- Auth: required
- Body: none
- Flags:
- `--org_id` (path, required, int64): org_id
## signing_keys
### `grafana grafana_http_api signing_keys retrieve-jwks`
- Summary: Get JSON Web Key Set (JWKS) with all the keys that can be used to verify tokens (public keys)
- HTTP: `GET /signing-keys/keys`
- Auth: required
- Body: none
- Flags: none
## snapshots
### `grafana grafana_http_api snapshots get-sharing-options`
- Summary: Get snapshot sharing settings.
- HTTP: `GET /snapshot/shared-options`
- Auth: required
- Body: none
- Flags: none
## sso_settings
### `grafana grafana_http_api sso_settings get-provider-settings`
- Summary: Get an SSO Settings entry by Key
- HTTP: `GET /v1/sso-settings/{key}`
- Auth: required
- Body: none
- Flags:
- `--key` (path, required): key
### `grafana grafana_http_api sso_settings list-all-providers-settings`
- Summary: List all SSO Settings entries
- HTTP: `GET /v1/sso-settings`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api sso_settings patch-provider-settings`
- Summary: Patch SSO Settings
- HTTP: `PATCH /v1/sso-settings/{key}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--key` (path, required): key
### `grafana grafana_http_api sso_settings remove-provider-settings`
- Summary: Remove SSO Settings
- HTTP: `DELETE /v1/sso-settings/{key}`
- Auth: required
- Body: none
- Flags:
- `--key` (path, required): key
### `grafana grafana_http_api sso_settings update-provider-settings`
- Summary: Update SSO Settings
- HTTP: `PUT /v1/sso-settings/{key}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--key` (path, required): key
## sync_team_groups
### `grafana grafana_http_api sync_team_groups add-team-group-api`
- Summary: Add External Group.
- HTTP: `POST /teams/{teamId}/groups`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team-id` (path, required): teamId
### `grafana grafana_http_api sync_team_groups get-team-groups-api`
- Summary: Get External Groups.
- HTTP: `GET /teams/{teamId}/groups`
- Auth: required
- Body: none
- Flags:
- `--team-id` (path, required): teamId
### `grafana grafana_http_api sync_team_groups remove-team-group-api-query`
- Summary: Remove External Group.
- HTTP: `DELETE /teams/{teamId}/groups`
- Auth: required
- Body: none
- Flags:
- `--group-id` (query): groupId
- `--team-id` (path, required): teamId
### `grafana grafana_http_api sync_team_groups search-team-groups`
- Summary: Search for team groups with optional filtering and pagination.
- HTTP: `GET /teams/{teamId}/groups/search`
- Auth: required
- Body: none
- Flags:
- `--team-id` (path, required, int64): teamId
- `--page` (query, default `1`, int64): page
- `--perpage` (query, default `1000`, int64): Number of items per page
- `--query` (query): If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded.
- `--name` (query): Filter by exact name match
- Output: pagination `offset`
## teams
### `grafana grafana_http_api teams add-team-member`
- Summary: Add Team Member.
- HTTP: `POST /teams/{team_id}/members`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams create-team`
- Summary: Add Team.
- HTTP: `POST /teams`
- Auth: required
- Body: required; media type `application/json`
- Flags: none
### `grafana grafana_http_api teams delete-team-by-id`
- Summary: Delete Team By ID.
- HTTP: `DELETE /teams/{team_id}`
- Auth: required
- Body: none
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams get-team-by-id`
- Summary: Get Team By ID.
- HTTP: `GET /teams/{team_id}`
- Auth: required
- Body: none
- Flags:
- `--team_id` (path, required): team_id
- `--accesscontrol` (query, default `false`): accesscontrol
### `grafana grafana_http_api teams get-team-members`
- Summary: Get Team Members.
- HTTP: `GET /teams/{team_id}/members`
- Auth: required
- Body: none
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams get-team-preferences`
- Summary: Get Team Preferences.
- HTTP: `GET /teams/{team_id}/preferences`
- Auth: required
- Body: none
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams remove-team-member`
- Summary: Remove Member From Team.
- HTTP: `DELETE /teams/{team_id}/members/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--team_id` (path, required): team_id
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api teams search-teams`
- Summary: Team Search With Paging.
- HTTP: `GET /teams/search`
- Auth: required
- Body: none
- Flags:
- `--page` (query, default `1`, int64): page
- `--perpage` (query, default `1000`, int64): Number of items per page
- `--name` (query): name
- `--query` (query): If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded.
- `--accesscontrol` (query, default `false`): accesscontrol
- `--sort` (query): sort
- Output: pagination `offset`
### `grafana grafana_http_api teams set-team-memberships`
- Summary: Set team memberships.
- HTTP: `PUT /teams/{team_id}/members`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams update-team`
- Summary: Update Team.
- HTTP: `PUT /teams/{team_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team_id` (path, required): team_id
### `grafana grafana_http_api teams update-team-member`
- Summary: Update Team Member.
- HTTP: `PUT /teams/{team_id}/members/{user_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team_id` (path, required): team_id
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api teams update-team-preferences`
- Summary: Update Team Preferences.
- HTTP: `PUT /teams/{team_id}/preferences`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--team_id` (path, required): team_id
## user
### `grafana grafana_http_api user update-user-email`
- Summary: Update user email.
- HTTP: `GET /user/email/update`
- Auth: required
- Body: none
- Flags: none
## users
### `grafana grafana_http_api users get-user-by-id`
- Summary: Get user by id.
- HTTP: `GET /users/{user_id}`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api users get-user-by-login-or-email`
- Summary: Get user by login or email.
- HTTP: `GET /users/lookup`
- Auth: required
- Body: none
- Flags:
- `--login-or-email` (query, required): loginOrEmail of the user
### `grafana grafana_http_api users get-user-org-list`
- Summary: Get organizations for user.
- HTTP: `GET /users/{user_id}/orgs`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api users get-user-teams`
- Summary: Get teams for user.
- HTTP: `GET /users/{user_id}/teams`
- Auth: required
- Body: none
- Flags:
- `--user_id` (path, required, int64): user_id
### `grafana grafana_http_api users search-users`
- Summary: Get users.
- HTTP: `GET /users`
- Auth: required
- Body: none
- Flags:
- `--perpage` (query, default `1000`, int64): Limit the maximum number of users to return per page
- `--page` (query, default `1`, int64): Page index for starting fetching users
- Output: pagination `offset`
### `grafana grafana_http_api users search-users-with-paging`
- Summary: Get users with paging.
- HTTP: `GET /users/search`
- Auth: required
- Body: none
- Flags: none
### `grafana grafana_http_api users update-user`
- Summary: Update user.
- HTTP: `PUT /users/{user_id}`
- Auth: required
- Body: required; media type `application/json`
- Flags:
- `--user_id` (path, required, int64): user_id