public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[v11.5] Remove relref shortcodes (#101707)

Browse Source 
* manually replce all shared relrefs

* relref replace - grafana v11.5

* Merge branch 'master' into robbymilo/relref-replace-grafana-11.5

* manual fixes

* replace ref shortcodes

* Merge branch 'master' into robbymilo/relref-replace-grafana-11.5

* update readme

* update test

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Robby Milo
2025-03-06 17:48:00 +02:00
committed by GitHub
co-authored by Jack Baldry
parent fe4442a7fb
commit 96d15d9091
181 changed files with 1563 additions and 1577 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/_index.md
+32 -32
View File
@@ -49,44 +49,44 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
## HTTP APIs
- [Admin API]({{< relref "admin/" >}})
- [Admin API](admin/)
- [Alerting API (unstable)](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json)
- [Alerting provisioning API]({{< relref "alerting_provisioning/" >}})
- [Annotations API]({{< relref "annotations/" >}})
- [Correlations API]({{< relref "correlations/" >}})
- [Dashboard API]({{< relref "dashboard/" >}})
- [Dashboard permissions API]({{< relref "dashboard_permissions/" >}})
- [Dashboard versions API]({{< relref "dashboard_versions/" >}})
- [Data source API]({{< relref "data_source/" >}})
- [Folder API]({{< relref "folder/" >}})
- [Folder permissions API]({{< relref "folder_permissions/" >}})
- [Folder/Dashboard search API]({{< relref "folder_dashboard_search/" >}})
- [Library element API]({{< relref "library_element/" >}})
- [Organization API]({{< relref "org/" >}})
- [Other API]({{< relref "other/" >}})
- [Playlists API]({{< relref "playlist/" >}})
- [Preferences API]({{< relref "preferences/" >}})
- [Shared dashboards API]({{< relref "dashboard_public/" >}})
- [Query history API]({{< relref "query_history/" >}})
- [Service account API]({{< relref "serviceaccount/" >}})
- [Short URL API]({{< relref "short_url/" >}})
- [Snapshot API]({{< relref "snapshot/" >}})
- [SSO settings API]({{< relref "sso-settings/" >}})
- [Team API]({{< relref "team/" >}})
- [User API]({{< relref "user/" >}})
- [Alerting provisioning API](alerting_provisioning/)
- [Annotations API](annotations/)
- [Correlations API](correlations/)
- [Dashboard API](dashboard/)
- [Dashboard permissions API](dashboard_permissions/)
- [Dashboard versions API](dashboard_versions/)
- [Data source API](data_source/)
- [Folder API](folder/)
- [Folder permissions API](folder_permissions/)
- [Folder/Dashboard search API](folder_dashboard_search/)
- [Library element API](library_element/)
- [Organization API](org/)
- [Other API](other/)
- [Playlists API](playlist/)
- [Preferences API](preferences/)
- [Shared dashboards API](dashboard_public/)
- [Query history API](query_history/)
- [Service account API](serviceaccount/)
- [Short URL API](short_url/)
- [Snapshot API](snapshot/)
- [SSO settings API](sso-settings/)
- [Team API](team/)
- [User API](user/)
## Deprecated HTTP APIs
- [Authentication API]({{< relref "auth/" >}})
- [Authentication API](auth/)
## Grafana Enterprise HTTP APIs
Grafana Enterprise includes all of the Grafana OSS APIs as well as the following APIs:
- [Data source permissions API]({{< relref "datasource_permissions/" >}})
- [Group attribute sync API]({{< relref "group_attribute_sync/" >}})
- [License API]({{< relref "licensing/" >}})
- [Query and resource caching API]({{< relref "query_and_resource_caching/" >}})
- [Reporting API]({{< relref "reporting/" >}})
- [Role-based access control API]({{< relref "access_control/" >}})
- [Team sync API]({{< relref "team_sync/" >}})
- [Data source permissions API](datasource_permissions/)
- [Group attribute sync API](group_attribute_sync/)
- [License API](licensing/)
- [Query and resource caching API](query_and_resource_caching/)
- [Reporting API](reporting/)
- [Role-based access control API](access_control/)
- [Team sync API](team_sync/)
docs/sources/developers/http_api/access_control.md
+39 -39
View File
@@ -21,11 +21,11 @@ title: RBAC HTTP API
# RBAC API
> Role-based access control API is only available in Grafana Cloud or Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
> Role-based access control API is only available in Grafana Cloud or Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
The API can be used to create, update, delete, get, and list roles.
To check which basic or fixed roles have the required permissions, refer to [RBAC role definitions]({{< ref "/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions" >}}).
To check which basic or fixed roles have the required permissions, refer to [RBAC role definitions](/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions).
## Get status
@@ -226,7 +226,7 @@ Content-Type: application/json; charset=UTF-8
`POST /api/access-control/roles`
Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as [Fixed roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control#fixed-roles" >}}) can't be created.
Creates a new custom role and maps given permissions to that role. Note that roles with the same prefix as [Fixed roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/#fixed-roles) can't be created.
#### Required permissions
@@ -264,24 +264,24 @@ Content-Type: application/json
#### JSON body schema
| Field Name | Date Type | Required | Description |
| ----------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uid | string | No | UID of the role. If not present, the UID will be automatically created for you and returned in response. Refer to the [Custom roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control#custom-roles" >}}) for more information. |
| global | boolean | No | A flag indicating if the role is global or not. If set to `false`, the default org ID of the authenticated user will be used from the request. |
| version | number | No | Version of the role. If not present, version 0 will be assigned to the role and returned in the response. Refer to the [Custom roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/#custom-roles" >}}) for more information. |
| name | string | Yes | Name of the role. Refer to [Custom roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control#custom-roles" >}}) for more information. |
| description | string | No | Description of the role. |
| displayName | string | No | Display name of the role, visible in the UI. |
| group | string | No | The group name the role belongs to. |
| hidden | boolean | No | Specify whether the role is hidden or not. If set to `true`, then the role does not show in the role picker. It will not be listed by API endpoints unless explicitly specified. |
| permissions | Permission | No | If not present, the role will be created without any permissions. |
| Field Name | Date Type | Required | Description |
| ----------- | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| uid | string | No | UID of the role. If not present, the UID will be automatically created for you and returned in response. Refer to the [Custom roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/#custom-roles) for more information. |
| global | boolean | No | A flag indicating if the role is global or not. If set to `false`, the default org ID of the authenticated user will be used from the request. |
| version | number | No | Version of the role. If not present, version 0 will be assigned to the role and returned in the response. Refer to the [Custom roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/#custom-roles) for more information. |
| name | string | Yes | Name of the role. Refer to [Custom roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/#custom-roles) for more information. |
| description | string | No | Description of the role. |
| displayName | string | No | Display name of the role, visible in the UI. |
| group | string | No | The group name the role belongs to. |
| hidden | boolean | No | Specify whether the role is hidden or not. If set to `true`, then the role does not show in the role picker. It will not be listed by API endpoints unless explicitly specified. |
| permissions | Permission | No | If not present, the role will be created without any permissions. |
**Permission**
| Field Name | Data Type | Required | Description |
| ---------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for full list of available actions. |
| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for full list of available scopes. |
| Field Name | Data Type | Required | Description |
| ---------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action | string | Yes | Refer to [Custom role actions and scopes](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for full list of available actions. |
| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for full list of available scopes. |
#### Example response
@@ -449,10 +449,10 @@ Content-Type: application/json
**Permission**
| Field Name | Data Type | Required | Description |
| ---------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action | string | Yes | Refer to [Custom role actions and scopes]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for full list of available actions. |
| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for full list of available scopes. |
| Field Name | Data Type | Required | Description |
| ---------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| action | string | Yes | Refer to [Custom role actions and scopes](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for full list of available actions. |
| scope | string | No | If not present, no scope will be mapped to the permission. Refer to [Custom role actions and scopes](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for full list of available scopes. |
#### Example response
@@ -494,7 +494,7 @@ Permission validation only occurs when permission validation is enabled (`rbac.p
> It has been enabled by default since Grafana 10.2.
For more information, refer to [Create role validation errors]({{< ref "#create-role-validation-errors" >}}).
For more information, refer to [Create role validation errors](#create-role-validation-errors).
#### Status codes
@@ -530,10 +530,10 @@ Accept: application/json
#### Query parameters
| Param | Type | Required | Description |
| ------ | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| force | boolean | No | When set to `true`, the role will be deleted with all its assignments. |
| global | boolean | No | A flag indicating if the role is global or not. If set to false, the default org ID of the authenticated user will be used from the request. Refer to the [About RBAC]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control" >}}) for more information. |
| Param | Type | Required | Description |
| ------ | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| force | boolean | No | When set to `true`, the role will be deleted with all its assignments. |
| global | boolean | No | A flag indicating if the role is global or not. If set to false, the default org ID of the authenticated user will be used from the request. Refer to the [About RBAC](/docs/grafana/latest/administration/roles-and-permissions/access-control/) for more information. |
#### Example response
@@ -711,7 +711,7 @@ Content-Type: application/json; charset=UTF-8
Assign a role to a specific user.
For bulk updates consider
[Set user role assignments]({{< ref "#set-user-role-assignments" >}}).
[Set user role assignments](#set-user-role-assignments).
#### Required permissions
@@ -769,7 +769,7 @@ Content-Type: application/json; charset=UTF-8
Revoke a role from a user.
For bulk updates consider
[Set user role assignments]({{< ref "#set-user-role-assignments" >}}).
[Set user role assignments](#set-user-role-assignments).
#### Required permissions
@@ -821,8 +821,8 @@ This will remove any assigned roles that aren't in the request and add
roles that are in the set but are not already assigned to the user.
If you want to add or remove a single role, consider using
[Add a user role assignment]({{< ref "#add-a-user-role-assignment" >}}) or
[Remove a user role assignment]({{< ref "#remove-a-user-role-assignment" >}})
[Add a user role assignment](#add-a-user-role-assignment) or
[Remove a user role assignment](#remove-a-user-role-assignment)
instead.
#### Required permissions
@@ -985,7 +985,7 @@ Content-Type: application/json; charset=UTF-8
Assign a role to a specific service account.
For bulk updates consider
[Set service account role assignments]({{< ref "#set-service-account-role-assignments" >}}).
[Set service account role assignments](#set-service-account-role-assignments).
#### Required permissions
@@ -1043,7 +1043,7 @@ Content-Type: application/json; charset=UTF-8
Revoke a role from a service account.
For bulk updates consider
[Set service account role assignments]({{< ref "#set-service-account-role-assignments" >}}).
[Set service account role assignments](#set-service-account-role-assignments).
#### Required permissions
@@ -1095,8 +1095,8 @@ This will remove any assigned roles that aren't in the request and add
roles that are in the set but are not already assigned to the service account.
If you want to add or remove a single role, consider using
[Add a service account role assignment]({{< ref "#add-a-service-account-role-assignment" >}}) or
[Remove a service account role assignment]({{< ref "#remove-a-service-account-role-assignment" >}})
[Add a service account role assignment](#add-a-service-account-role-assignment) or
[Remove a service account role assignment](#remove-a-service-account-role-assignment)
instead.
#### Required permissions
@@ -1213,7 +1213,7 @@ Content-Type: application/json; charset=UTF-8
Assign a role to a specific team.
For bulk updates consider [Set team role assignments]({{< ref "#set-team-role-assignments" >}}).
For bulk updates consider [Set team role assignments](#set-team-role-assignments).
#### Required permissions
@@ -1268,7 +1268,7 @@ Content-Type: application/json; charset=UTF-8
Revoke a role from a team.
For bulk updates consider [Set team role assignments]({{< ref "#set-team-role-assignments" >}}).
For bulk updates consider [Set team role assignments](#set-team-role-assignments).
#### Required permissions
@@ -1314,8 +1314,8 @@ This will remove any assigned roles that aren't in the request and add
roles that are in the set but are not already assigned to the user.
If you want to add or remove a single role, consider using
[Add a team role assignment]({{< ref "#add-a-team-role-assignment" >}}) or
[Remove a team role assignment]({{< ref "#remove-a-team-role-assignment" >}})
[Add a team role assignment](#add-a-team-role-assignment) or
[Remove a team role assignment](#remove-a-team-role-assignment)
instead.
#### Required permissions
docs/sources/developers/http_api/admin.md
+29 -29
View File
@@ -28,17 +28,17 @@ To use these API endpoints you have to use Basic authentication and the Grafana
The `admin` user that Grafana is provisioned with by default has permissions to use these API endpoints.
{{< /admonition >}}
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](../../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Fetch settings
`GET /api/admin/settings`
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ------------- | ----------------------------------------------------------------------------------- |
@@ -213,7 +213,7 @@ This endpoint only supports changes to `auth.saml` configuration.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| -------------- | ----------------------------------------------------------------------------------- |
@@ -263,11 +263,11 @@ Status codes:
`GET /api/admin/stats`
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ----------------- | ----- |
@@ -307,7 +307,7 @@ Content-Type: application/json
Preview usage report to be sent to vendor.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Example Request**:
@@ -345,11 +345,11 @@ Content-Type: application/json
`POST /api/admin/users`
Create new user. Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Create new user. Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ------------ | ----- |
@@ -371,7 +371,7 @@ Content-Type: application/json
}
```
Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org]({{< relref "../../setup-grafana/configure-grafana/#auto-assign-org" >}}) is set to `true`.
Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org](../../../setup-grafana/configure-grafana/#auto-assign-org) is set to `true`.
**Example Response**:
@@ -386,12 +386,12 @@ Content-Type: application/json
`PUT /api/admin/users/:id/password`
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
Change password for a specific user.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| -------------------- | --------------- |
@@ -420,11 +420,11 @@ Content-Type: application/json
`PUT /api/admin/users/:id/permissions`
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ----------------------- | --------------- |
@@ -453,11 +453,11 @@ Content-Type: application/json
`DELETE /api/admin/users/:id`
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ------------ | --------------- |
@@ -486,11 +486,11 @@ Content-Type: application/json
Return a list of all auth tokens (devices) that the user currently have logged in from.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| -------------------- | --------------- |
@@ -545,11 +545,11 @@ Content-Type: application/json
Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in
and will be required to authenticate again upon next activity.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| --------------------- | --------------- |
@@ -585,11 +585,11 @@ Content-Type: application/json
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.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope |
| ------------ | --------------- |
@@ -630,11 +630,11 @@ Reloads the provisioning config files for specified type and provision entities
until the new provisioned entities are already stored in the database. In case of dashboards, it will stop
polling for changes in dashboard files and then restart it with new configurations after returning.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Required permissions**
See note in the [introduction]({{< ref "#admin-api" >}}) for an explanation.
See note in the [introduction](#admin-api) for an explanation.
| Action | Scope | Provision entity |
| ------------------- | -------------------------- | ---------------- |
@@ -669,7 +669,7 @@ Content-Type: application/json
Reloads the LDAP configuration.
Only works with Basic Authentication (username and password). See [introduction](http://docs.grafana.org/http_api/admin/#admin-api) for an explanation.
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/GRAFANA_VERSION/http_api/admin/#admin-api) for an explanation.
**Example Request**:
@@ -694,7 +694,7 @@ Content-Type: application/json
`POST /api/admin/encryption/rotate-data-keys`
[Rotates]({{< relref "../../setup-grafana/configure-security/configure-database-encryption/#rotate-data-keys" >}}) data encryption keys.
[Rotates](../../../setup-grafana/configure-security/configure-database-encryption/#rotate-data-keys) data encryption keys.
**Example Request**:
@@ -715,7 +715,7 @@ Content-Type: application/json
`POST /api/admin/encryption/reencrypt-data-keys`
[Re-encrypts]({{< relref "../../setup-grafana/configure-security/configure-database-encryption/#re-encrypt-data-keys" >}}) data encryption keys.
[Re-encrypts](../../../setup-grafana/configure-security/configure-database-encryption/#re-encrypt-data-keys) data encryption keys.
**Example Request**:
@@ -736,7 +736,7 @@ Content-Type: application/json
`POST /api/admin/encryption/reencrypt-secrets`
[Re-encrypts]({{< relref "../../setup-grafana/configure-security/configure-database-encryption/#re-encrypt-secrets" >}}) secrets.
[Re-encrypts](../../../setup-grafana/configure-security/configure-database-encryption/#re-encrypt-secrets) secrets.
**Example Request**:
@@ -757,7 +757,7 @@ Content-Type: application/json
`POST /api/admin/encryption/rollback-secrets`
[Rolls back]({{< relref "../../setup-grafana/configure-security/configure-database-encryption/#roll-back-secrets" >}}) secrets.
[Rolls back](../../../setup-grafana/configure-security/configure-database-encryption/#roll-back-secrets) secrets.
**Example Request**:
docs/sources/developers/http_api/annotations.md
+8 -8
View File
@@ -22,7 +22,7 @@ title: Annotations HTTP API
Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annotations can be organization annotations that can be shown on any dashboard by configuring an annotation data source - they are filtered by tags. Or they can be tied to a panel on a dashboard and are then only shown on that panel.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Find Annotations
@@ -30,7 +30,7 @@ Annotations are saved in the Grafana database (sqlite, mysql or postgres). Annot
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -123,7 +123,7 @@ The format for `time` and `timeEnd` should be epoch numbers in millisecond resol
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -178,7 +178,7 @@ format (string with multiple tags being separated by a space).
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
| Action | Scope |
| -------------------- | ------------------------------- |
@@ -219,7 +219,7 @@ Updates all properties of an annotation that matches the specified id. To only u
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -265,7 +265,7 @@ This operation currently supports updating of the `text`, `tags`, `time` and `ti
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -307,7 +307,7 @@ Deletes the annotation that matches the specified id.
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -344,7 +344,7 @@ Find all the event tags created in the annotations.
**Required permissions**
See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation.
See note in the [introduction](#annotations-api) for an explanation.
| Action | Scope |
| ------------------ | ----- |
docs/sources/developers/http_api/auth.md
+5 -5
View File
@@ -22,10 +22,10 @@ title: 'Authentication HTTP API '
The Authentication HTTP API is used to manage API keys.
{{% admonition type="note" %}}
Grafana recommends using service accounts instead of API keys. For more information, refer to [Grafana service account API reference]({{< relref "./serviceaccount/" >}}).
Grafana recommends using service accounts instead of API keys. For more information, refer to [Grafana service account API reference](../serviceaccount/).
{{% /admonition %}}
> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions](../../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## List API keys
@@ -38,7 +38,7 @@ This endpoint is deprecated.
**Required permissions**
See note in the [introduction]({{< ref "#authentication-api" >}}) for an explanation.
See note in the [introduction](#authentication-api) for an explanation.
| Action | Scope |
| -------------- | ----------- |
@@ -85,7 +85,7 @@ This endpoint has been made obsolete in Grafana 11.3.0.
{{% /admonition %}}
Endpoint is obsolete and has been moved to [Grafana service account API]({{< relref "./serviceaccount/" >}}). For more information, refer to [Migrate to Grafana service account API](/docs/grafana/<GRAFANA_VERSION>/administration/service-accounts/migrate-api-keys/).
Endpoint is obsolete and has been moved to [Grafana service account API](../serviceaccount/). For more information, refer to [Migrate to Grafana service account API](/docs/grafana/<GRAFANA_VERSION>/administration/service-accounts/migrate-api-keys/).
`POST /api/auth/keys`
@@ -110,7 +110,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#authentication-api" >}}) for an explanation.
See note in the [introduction](#authentication-api) for an explanation.
| Action | Scope |
| ---------------- | ---------- |
docs/sources/developers/http_api/dashboard.md
+9 -9
View File
@@ -18,7 +18,7 @@ title: Dashboard HTTP API
# Dashboard API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Identifier (id) vs unique identifier (uid)
@@ -26,7 +26,7 @@ The identifier (id) of a dashboard is an auto-incrementing numeric value and is
The unique identifier (uid) of a dashboard can be used for uniquely identify a dashboard between multiple Grafana installs.
It's automatically generated if not provided when creating a dashboard. The uid allows having consistent URLs for accessing
dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning]({{< relref "/docs/grafana/latest/administration/provisioning#dashboards" >}})
dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning](/docs/grafana/latest/administration/provisioning/#dashboards)
for more information. This means that changing the title of a dashboard will not break any bookmarked links to that dashboard.
The uid can have a maximum length of 40 characters.
@@ -41,7 +41,7 @@ Creates a new dashboard or updates an existing dashboard. When updating existing
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation.
See note in the [introduction](#dashboard-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -80,7 +80,7 @@ JSON Body schema:
- **dashboard** – The complete dashboard model.
- **dashboard.id** – id = null to create a new dashboard.
- **dashboard.uid** – Optional unique identifier when creating a dashboard. uid = null will generate a new uid.
- **dashboard.refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval]({{< relref "/docs/grafana/latest/setup-grafana/configure-grafana#min_refresh_interval" >}}), then Grafana will ignore it and will enforce the minimum refresh interval.
- **dashboard.refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval](/docs/grafana/latest/setup-grafana/configure-grafana/#min_refresh_interval), then Grafana will ignore it and will enforce the minimum refresh interval.
- **folderId** – The id of the folder to save the dashboard in.
- **folderUid** – The UID of the folder to save the dashboard in. Overrides the `folderId`.
- **overwrite** – Set to true if you want to overwrite an existing dashboard with a given dashboard UID.
@@ -166,7 +166,7 @@ Will return the dashboard given the dashboard unique identifier (uid). Informati
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation.
See note in the [introduction](#dashboard-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -225,7 +225,7 @@ Will delete the dashboard given the specified unique identifier (uid).
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation.
See note in the [introduction](#dashboard-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -275,7 +275,7 @@ Will delete permanently the dashboard given the specified unique identifier (uid
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation.
See note in the [introduction](#dashboard-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -325,7 +325,7 @@ Will restore a deleted dashboard given the specified unique identifier (uid).
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation.
See note in the [introduction](#dashboard-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -453,4 +453,4 @@ Content-Type: application/json
## Dashboard Search
See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}}).
See [Folder/Dashboard Search API](../folder_dashboard_search/).
docs/sources/developers/http_api/dashboard_permissions.md
+3 -3
View File
@@ -32,7 +32,7 @@ The permission levels for the permission field:
- 2 = Edit
- 4 = Admin
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Get permissions for a dashboard
@@ -42,7 +42,7 @@ Gets all existing permissions for the dashboard with the given `uid`.
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation.
See note in the [introduction](#dashboard-permission-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
@@ -124,7 +124,7 @@ Updates permissions for a dashboard. This operation will remove existing permiss
**Required permissions**
See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation.
See note in the [introduction](#dashboard-permission-api) for an explanation.
<!-- prettier-ignore-start -->
| Action | Scope |
docs/sources/developers/http_api/data_source.md
+12 -12
View File
@@ -19,7 +19,7 @@ title: Data source HTTP API
# Data source API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Get all data sources
@@ -31,7 +31,7 @@ This API currently doesn't handle pagination. The default maximum number of data
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ---------------- | -------------- |
@@ -90,7 +90,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ---------------- | ---------------------------------------------------------------------------- |
@@ -146,7 +146,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ---------------- | -------------------------------------------------------------------------------------- |
@@ -202,7 +202,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ---------------- | ---------------------------------------------------------------------------------------------- |
@@ -258,7 +258,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ------------------- | ---------------------------------------------------------------------------------------------- |
@@ -292,7 +292,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ------------------ | ----- |
@@ -446,7 +446,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ----------------- | ---------------------------------------------------------------------------- |
@@ -529,7 +529,7 @@ Similar to [creating a data source](#create-a-data-source), `password` and `basi
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ----------------- | -------------------------------------------------------------------------------------- |
@@ -617,7 +617,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ------------------ | ---------------------------------------------------------------------------- |
@@ -649,7 +649,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ------------------ | -------------------------------------------------------------------------------------- |
@@ -684,7 +684,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation.
See note in the [introduction](#data-source-api) for an explanation.
| Action | Scope |
| ------------------ | ---------------------------------------------------------------------------------------------- |
docs/sources/developers/http_api/datasource_permissions.md
+6 -6
View File
@@ -23,9 +23,9 @@ title: Datasource Permissions HTTP API
# Data Source Permissions API
> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
This API can be used to list, add and remove permissions for a data source.
@@ -39,7 +39,7 @@ Gets all existing permissions for the data source with the given `uid`.
**Required permissions**
See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation.
See note in the [introduction](#data-source-permissions-api) for an explanation.
| Action | Scope |
| ---------------------------- | ------------------------------------------------------------------------------------------ |
@@ -134,7 +134,7 @@ To remove a permission, set the `permission` field to an empty string.
**Required permissions**
See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation.
See note in the [introduction](#data-source-permissions-api) for an explanation.
| Action | Scope |
| ----------------------------- | ------------------------------------------------------------------------------------------ |
@@ -206,7 +206,7 @@ To remove a permission, set the `permission` field to an empty string.
**Required permissions**
See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation.
See note in the [introduction](#data-source-permissions-api) for an explanation.
| Action | Scope |
| ----------------------------- | ------------------------------------------------------------------------------------------ |
@@ -280,7 +280,7 @@ To remove a permission, set the `permission` field to an empty string.
**Required permissions**
See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation.
See note in the [introduction](#data-source-permissions-api) for an explanation.
| Action | Scope |
| ----------------------------- | ------------------------------------------------------------------------------------------ |
docs/sources/developers/http_api/examples/create-api-tokens-for-org.md
+6 -6
View File
@@ -32,7 +32,7 @@ There are two authentication methods to access the API:
The task is to create a new organization and then add a Token that can be used by other users. In the examples below which use basic auth, the user is `admin` and the password is `admin`.
1. [Create the org](http://docs.grafana.org/http_api/org/#create-organization). Here is an example using curl:
1. [Create the org](/docs/grafana/GRAFANA_VERSION/http_api/org/#create-organization). Here is an example using curl:
```bash
curl -X POST -H "Content-Type: application/json" -d '{"name":"apiorg"}' http://admin:admin@localhost:3000/api/orgs
@@ -40,25 +40,25 @@ The task is to create a new organization and then add a Token that can be used b
This should return a response: `{"message":"Organization created","orgId":6}`. Use the orgId for the next steps.
1. Optional step. If the org was created previously and/or step 3 fails then first [add your Admin user to the org](http://docs.grafana.org/http_api/org/#add-user-in-organization):
1. Optional step. If the org was created previously and/or step 3 fails then first [add your Admin user to the org](/docs/grafana/GRAFANA_VERSION/http_api/org/#add-user-in-organization):
```bash
curl -X POST -H "Content-Type: application/json" -d '{"loginOrEmail":"admin", "role": "Admin"}' http://admin:admin@localhost:3000/api/orgs/<org id of new org>/users
```
1. [Switch the org context for the Admin user to the new org](http://docs.grafana.org/http_api/user/#switch-user-context-for-signed-in-user):
1. [Switch the org context for the Admin user to the new org](/docs/grafana/GRAFANA_VERSION/http_api/user/#switch-user-context-for-signed-in-user):
```bash
curl -X POST http://admin:admin@localhost:3000/api/user/using/<id of new org>
```
1. [Create a Service Account]({{< relref "./serviceaccount/#create-service-account" >}}):
1. [Create a Service Account](./serviceaccount/#create-service-account):
```bash
curl -X POST -H "Content-Type: application/json" -d '{"name":"test", "role": "Admin"}' http://admin:admin@localhost:3000/api/serviceaccounts
```
1. [Create a Service Account token]({{< relref "./serviceaccount/#create-service-account-tokens" >}}) for the service account created in the previous step:
1. [Create a Service Account token](./serviceaccount/#create-service-account-tokens) for the service account created in the previous step:
```bash
curl -X POST -H "Content-Type: application/json" -d '{"name":"test-token"}' http://admin:admin@localhost:3000/api/serviceaccounts/<service account id>/tokens
@@ -83,7 +83,7 @@ The task is to create a new organization and then add a Token that can be used b
Using the Token that was created in the previous step, you can create a dashboard or carry out other actions without having to switch organizations.
1. [Add a dashboard](http://docs.grafana.org/http_api/dashboard/#create-update-dashboard) using the key (or bearer token as it is also called):
1. [Add a dashboard](/docs/grafana/GRAFANA_VERSION/http_api/dashboard/#create-update-dashboard) using the key (or bearer token as it is also called):
```bash
curl -X POST --insecure -H "Authorization: Bearer eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ==" -H "Content-Type: application/json" -d '{
docs/sources/developers/http_api/examples/curl-examples.md
+3 -3
View File
@@ -27,16 +27,16 @@ The most basic example for a dashboard for which there is no authentication. You
curl http://localhost:3000/api/search
```
Here's a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication]({{< relref "/docs/grafana/latest/setup-grafana/configure-security/configure-authentication#basic-auth" >}}) enabled using the default admin credentials:
Here's a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication](/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/#basic-auth) enabled using the default admin credentials:
```
curl http://admin:admin@localhost:3000/api/search
```
To pass a username and password with [HTTP basic authorization]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}), encode them as base64.
To pass a username and password with [HTTP basic authorization](/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles/), encode them as base64.
You can't use authorization tokens in the request.
For example, to [list permissions associated with roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}) given a username of `user` and password of `password`, use:
For example, to [list permissions associated with roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles/) given a username of `user` and password of `password`, use:
```
curl --location '<grafana_url>/api/access-control/builtin-roles' --user 'user:password'
docs/sources/developers/http_api/folder.md
+10 -10
View File
@@ -18,7 +18,7 @@ title: Folder HTTP API
# Folder API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Identifier (id) vs unique identifier (uid)
@@ -40,7 +40,7 @@ that the authenticated user has permission to view.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
| -------------- | ----------- |
@@ -83,7 +83,7 @@ Will return the folder given the folder uid.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
| -------------- | ----------- |
@@ -141,7 +141,7 @@ Creates a new folder.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
`folders:create` allows creating folders and subfolders. If granted with scope `folders:uid:general`, allows creating root level folders. Otherwise, allows creating subfolders under the specified folders.
@@ -167,7 +167,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
JSON Body schema:
- **uid** – Optional [unique identifier]({{< ref "#identifier-id-vs-unique-identifier-uid" >}}).
- **uid** – Optional [unique identifier](#identifier-id-vs-unique-identifier-uid).
- **title** – The title of the folder.
- **parentUid** - Optional field, the unique identifier of the parent folder under which the folder should be created. Requires nested folders to be enabled.
@@ -215,7 +215,7 @@ Updates an existing folder identified by uid.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
| --------------- | ----------- |
@@ -302,11 +302,11 @@ Content-Length: 97
Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted.
If [Grafana Alerting]({{< relref "/docs/grafana/latest/alerting" >}}) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder.
If [Grafana Alerting](/docs/grafana/latest/alerting/) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
| Action | Scope |
| ---------------- | ----------- |
@@ -352,7 +352,7 @@ This is relevant only if nested folders are enabled.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
See note in the [introduction](#folder-api) for an explanation.
If moving the folder under another folder:
@@ -367,7 +367,7 @@ If moving the folder under root:
JSON body schema:
- **parentUid** – Optional [unique identifier]({{< relref "#identifier-id-vs-unique-identifier-uid" >}}) of the new parent folder. If this is empty, then the folder is moved under the root.
- **parentUid** – Optional [unique identifier](#identifier-id-vs-unique-identifier-uid) of the new parent folder. If this is empty, then the folder is moved under the root.
**Example Request**:
docs/sources/developers/http_api/folder_dashboard_search.md
+1 -1
View File
@@ -24,7 +24,7 @@ title: Folder/Dashboard Search HTTP API
`GET /api/search/`
> Note: When using [Role-based access control]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control" >}}), search results will contain only dashboards and folders which you have access to.
> Note: When using [Role-based access control](/docs/grafana/latest/administration/roles-and-permissions/access-control/), search results will contain only dashboards and folders which you have access to.
Query parameters:
docs/sources/developers/http_api/folder_permissions.md
+3 -3
View File
@@ -32,7 +32,7 @@ The permission levels for the permission field:
- 2 = Edit
- 4 = Admin
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Get permissions for a folder
@@ -42,7 +42,7 @@ Gets all existing permissions for the folder with the given `uid`.
**Required permissions**
See note in the [introduction]({{< ref "#folder-permission-api" >}}) for an explanation.
See note in the [introduction](#folder-permission-api) for an explanation.
| Action | Scope |
| -------------------------- | ----------- |
@@ -121,7 +121,7 @@ Updates permissions for a folder. This operation will remove existing permission
**Required permissions**
See note in the [introduction]({{< ref "#folder-permission-api" >}}) for an explanation.
See note in the [introduction](#folder-permission-api) for an explanation.
| Action | Scope |
| --------------------------- | ----------- |
docs/sources/developers/http_api/library_element.md
+2 -2
View File
@@ -286,7 +286,7 @@ JSON Body schema:
- `name`: Optional, the name of the library element.
- `model`: The JSON model for the library element.
- `kind`: Kind of element to create, Use `1` for library panels or `2` for library variables.
- `uid`: Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid).
- `uid`: Optional, the [unique identifier](#identifier-id-vs-unique-identifier-uid).
**Example Request**:
@@ -366,7 +366,7 @@ JSON Body schema:
- `model`: The JSON model for the library element.
- `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables.
- `version`: Version of the library element you are updating.
- `uid`: Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid).
- `uid`: Optional, the [unique identifier](#identifier-id-vs-unique-identifier-uid).
**Example Request**:
docs/sources/developers/http_api/licensing.md
+6 -6
View File
@@ -19,7 +19,7 @@ title: Licensing HTTP API
# Enterprise License API
Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
{{< admonition type="caution" >}}
You can't authenticate to the Licensing HTTP API with service account tokens.
@@ -31,7 +31,7 @@ To use these API endpoints you have to use Basic authentication and the Grafana
The `admin` user that Grafana is provisioned with by default has permissions to use these API endpoints.
{{< /admonition >}}
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Check license availability
@@ -43,7 +43,7 @@ Checks if a valid license is available.
**Required permissions**
See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation.
See note in the [introduction](#enterprise-license-api) for an explanation.
| Action | Scope |
| -------------- | ----- |
@@ -85,7 +85,7 @@ Applies a license to a Grafana instance.
**Required permissions**
See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation.
See note in the [introduction](#enterprise-license-api) for an explanation.
| Action | Scope |
| --------------- | ----- |
@@ -147,7 +147,7 @@ Manually ask license issuer for a new token.
**Required permissions**
See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation.
See note in the [introduction](#enterprise-license-api) for an explanation.
| Action | Scope |
| --------------- | ----- |
@@ -208,7 +208,7 @@ Removes the license stored in the Grafana database.
**Required permissions**
See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation.
See note in the [introduction](#enterprise-license-api) for an explanation.
| Action | Scope |
| ---------------- | ----- |
docs/sources/developers/http_api/org.md
+18 -18
View File
@@ -23,7 +23,7 @@ The Organization HTTP API is divided in two resources, `/api/org` (current organ
and `/api/orgs` (admin organizations). One big difference between these are that
the admin of all organizations API only works with basic authentication, see [Admin Organizations API](#admin-organizations-api) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Current Organization API
@@ -33,7 +33,7 @@ the admin of all organizations API only works with basic authentication, see [Ad
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| --------- | ----- |
@@ -69,7 +69,7 @@ Accessible to users with org admin role.
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| -------------- | -------- |
@@ -115,7 +115,7 @@ when editing folder/dashboard permissions.
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| -------------- | -------- |
@@ -151,7 +151,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| --------------- | -------- |
@@ -185,7 +185,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ---------------- | -------- |
@@ -215,7 +215,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ---------- | ----- |
@@ -251,7 +251,7 @@ Adds a global user to the current organization.
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ------------- | -------- |
@@ -300,7 +300,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| --------- | ----- |
@@ -342,7 +342,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope | Note |
| --------- | ----- | ------------------------------ |
@@ -384,7 +384,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope | Note |
| ----------- | ----- | ------------------------------ |
@@ -427,7 +427,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope | Note |
| --------- | ----- | ------------------------------ |
@@ -469,7 +469,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ---------- | ----- |
@@ -504,7 +504,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ----------- | ----- |
@@ -534,7 +534,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| -------------- | -------- |
@@ -575,7 +575,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ------------- | -------- |
@@ -611,7 +611,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| --------------- | -------- |
@@ -646,7 +646,7 @@ Only works with Basic Authentication (username and password), see [introduction]
**Required permissions**
See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation.
See note in the [introduction](#organization-api) for an explanation.
| Action | Scope |
| ---------------- | -------- |
docs/sources/developers/http_api/query_and_resource_caching.md
+6 -6
View File
@@ -24,7 +24,7 @@ title: Query and Resource Caching HTTP API
# Query and resource caching API
{{% admonition type="note" %}}
If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
{{% /admonition %}}
## Enable caching for a data source
@@ -33,7 +33,7 @@ If you are running Grafana Enterprise, for some endpoints you'll need to have sp
**Required permissions**
See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation.
See note in the [introduction](#query-and-resource-caching-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------- |
@@ -83,7 +83,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation.
See note in the [introduction](#query-and-resource-caching-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------- |
@@ -135,7 +135,7 @@ Will clean cached data for _all_ data sources with caching enabled. The `dataSou
**Required permissions**
See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation.
See note in the [introduction](#query-and-resource-caching-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------- |
@@ -185,7 +185,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation.
See note in the [introduction](#query-and-resource-caching-api) for an explanation.
| Action | Scope |
| ------------------------- | -------------- |
@@ -256,7 +256,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation.
See note in the [introduction](#query-and-resource-caching-api) for an explanation.
| Action | Scope |
| ------------------------ | -------------- |
docs/sources/developers/http_api/reporting.md
+22 -22
View File
@@ -17,13 +17,13 @@ title: Reporting API
# Reporting API
This API allows you to interact programmatically with the [Reporting]({{< relref "/docs/grafana/latest/dashboards/create-reports" >}}) feature.
This API allows you to interact programmatically with the [Reporting](/docs/grafana/latest/dashboards/create-reports/) feature.
> The Reporting API is not stabilized yet, it is still in active development and may change without prior notice.
> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## List all reports
@@ -31,7 +31,7 @@ This API allows you to interact programmatically with the [Reporting]({{< relref
#### Required permissions
See note in the [introduction]({{< relref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ------------ | --------------------------- |
@@ -103,7 +103,7 @@ Content-Length: 1840
### Status Codes
- **200** – OK
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **500** – Unexpected error or server misconfiguration. Refer to server logs for more details.
## Get a report
@@ -112,7 +112,7 @@ Content-Length: 1840
#### Required permissions
See note in the [introduction]({{< relref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ------------ | ---------------------------------------------------------- |
@@ -187,7 +187,7 @@ Content-Length: 940
- **200** – OK
- **400** – Bad request (invalid report ID).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **403** – Forbidden (access denied to a report or a dashboard used in the report).
- **404** – Not found (such report does not exist).
- **500** – Unexpected error or server misconfiguration. Refer to server logs for more details.
@@ -198,7 +198,7 @@ Content-Length: 940
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| -------------- | ----- |
@@ -308,7 +308,7 @@ Content-Length: 35
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ------------- | --------------------------------------------------------- |
@@ -316,7 +316,7 @@ See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
### Example request
See [JSON body schema]({{< ref "#config-json-body-schema" >}}) for fields description.
See [JSON body schema](#config-json-body-schema) for fields description.
```http
GET /api/reports HTTP/1.1
@@ -381,7 +381,7 @@ Content-Length: 28
- **200** – OK
- **400** – Bad request (invalid json, missing or invalid fields values, etc.).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **403** – Forbidden (access denied to a report or a dashboard used in the report).
- **404** – Not found (such report does not exist).
- **500** – Unexpected error or server misconfiguration. Refer to server logs for more details.
@@ -392,7 +392,7 @@ Content-Length: 28
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| -------------- | --------------------------------------------------------- |
@@ -423,7 +423,7 @@ Content-Length: 39
- **200** – OK
- **400** – Bad request (invalid report ID).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **404** - Not found (report with this ID does not exist).
- **500** - Unexpected error or server misconfiguration. Refer to server logs for more details
@@ -435,7 +435,7 @@ Generate and send a report. This API waits for the report to be generated before
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ------------ | ----- |
@@ -477,7 +477,7 @@ Content-Length: 29
- **200** – Report was sent.
- **400** – Bad request (invalid json, missing content-type, missing or invalid fields, etc.).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **403** - Forbidden (access denied to a report or a dashboard used in the report).
- **404** - Report not found.
- **500** - Unexpected error or server misconfiguration. Refer to server logs for more details.
@@ -490,7 +490,7 @@ Returns reports branding settings that are global and used across all the report
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| --------------------- | ----- |
@@ -529,7 +529,7 @@ Content-Length: 181
### Status Codes
- **200** – OK
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **500** - Unexpected error or server misconfiguration. Refer to server logs for more detail
## Save reports branding settings
@@ -540,7 +540,7 @@ Creates settings if they don't exist, otherwise updates them. These settings are
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ---------------------- | ----- |
@@ -591,7 +591,7 @@ Content-Length: 35
- **200** – OK
- **400** – Bad request (invalid json, missing or invalid fields values, etc.).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **500** - Unexpected error or server misconfiguration. Refer to server logs for more detail
## Send a test email
@@ -602,7 +602,7 @@ Sends a test email with a report without persisting it in the database.
#### Required permissions
See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
See note in the [introduction](#reporting-api) for an explanation.
| Action | Scope |
| ------------ | ----- |
@@ -610,7 +610,7 @@ See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation.
### Example request
See [JSON body schema]({{< ref "#config-json-body-schema" >}}) for fields description.
See [JSON body schema](#config-json-body-schema) for fields description.
```http
POST /api/reports/test-email HTTP/1.1
@@ -674,6 +674,6 @@ Content-Length: 29
- **200** – OK
- **400** – Bad request (invalid json, missing or invalid fields values, etc.).
- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}).
- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/).
- **403** - Forbidden (access denied to a report or a dashboard used in the report).
- **500** - Unexpected error or server misconfiguration. Refer to server logs for more details
docs/sources/developers/http_api/serviceaccount.md
+14 -14
View File
@@ -18,7 +18,7 @@ title: Service account HTTP API
# Service account API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
> For Grafana Cloud instances, please use a Bearer token to authenticate. The examples within this section reference Basic authentication which is for On-Prem Grafana instances.
## Search service accounts with Paging
@@ -27,7 +27,7 @@ title: Service account HTTP API
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| -------------------- | ----- |
@@ -94,7 +94,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| ---------------------- | ----- |
@@ -141,7 +141,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| -------------------- | --------------------- |
@@ -182,7 +182,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | --------------------- |
@@ -228,7 +228,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| ---------------------- | --------------------- |
@@ -262,7 +262,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | ------------------ |
@@ -294,7 +294,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | ------------------ |
@@ -326,7 +326,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| -------------------- | ------------------ |
@@ -358,7 +358,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | ------------------ |
@@ -390,7 +390,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| -------------------- | --------------------- |
@@ -430,7 +430,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | --------------------- |
@@ -471,7 +471,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| --------------------- | --------------------- |
@@ -505,7 +505,7 @@ This operation will delete the service account and create a legacy API Key for t
**Required permissions**
See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation.
See note in the [introduction](#service-account-api) for an explanation.
| Action | Scope |
| ---------------------- | --------------------- |
docs/sources/developers/http_api/short_url.md
+1 -1
View File
@@ -41,7 +41,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
JSON body schema:
- **path** – The path to shorten, relative to the Grafana [root_url]({{< relref "/docs/grafana/latest/setup-grafana/configure-grafana#root_url" >}}).
- **path** – The path to shorten, relative to the Grafana [root_url](/docs/grafana/latest/setup-grafana/configure-grafana/#root_url).
**Example response:**
docs/sources/developers/http_api/sso-settings.md
+6 -6
View File
@@ -20,7 +20,7 @@ title: SSO Settings API
# SSO Settings API
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
{{% admonition type="note" %}}
Available since Grafana 11. SAML support is in public preview behind the `ssoSettingsSAML` feature flag.
@@ -29,7 +29,7 @@ Available since Grafana 11. SAML support is in public preview behind the `ssoSet
The API can be used to create, update, delete, get, and list SSO Settings for OAuth2 and SAML.
The settings managed by this API are stored in the database and override
[settings from other sources]({{< relref "../../setup-grafana/configure-security/configure-authentication" >}})
[settings from other sources](../../../setup-grafana/configure-security/configure-authentication/)
(arguments, environment variables, settings file, etc).
Therefore, every time settings for a specific provider are removed or reset to the default settings at runtime,
the settings are inherited from the other sources in the reverse order of precedence
@@ -45,7 +45,7 @@ The providers or SSO keys that are not managed by this API are retrieved from th
**Required permissions**
See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation.
See note in the [introduction](#sso-settings) for an explanation.
| Action | Scope |
| --------------- | ---------------------------- |
@@ -112,7 +112,7 @@ The SSO keys that are not managed by this API are retrieved from the other sourc
**Required permissions**
See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation.
See note in the [introduction](#sso-settings) for an explanation.
| Action | Scope |
| --------------- | ---------------------------- |
@@ -175,7 +175,7 @@ to wait a few minutes for the configuration to propagate to all Grafana instance
**Required permissions**
See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation.
See note in the [introduction](#sso-settings) for an explanation.
| Action | Scope |
| ---------------- | ---------------------------- |
@@ -222,7 +222,7 @@ Deletes an existing SSO Settings entry for a provider.
**Required permissions**
See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation.
See note in the [introduction](#sso-settings) for an explanation.
| Action | Scope |
| ---------------- | ---------------------------- |
docs/sources/developers/http_api/team.md
+12 -12
View File
@@ -29,7 +29,7 @@ Access to these API endpoints is restricted as follows:
- If you enable `editors_can_admin` configuration flag, then Organization Editors can create teams and manage teams where they are Admin.
- If you enable `editors_can_admin` configuration flag, Editors can find out whether a team that they are not members of exists by trying to create a team with the same name.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Team Search With Paging
@@ -41,7 +41,7 @@ or
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ---------- | -------- |
@@ -107,7 +107,7 @@ The `name` parameter returns a single team if the parameter matches the `name` f
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ---------- | -------- |
@@ -153,7 +153,7 @@ The Team `name` needs to be unique. `name` is required and `email` is optional.
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ------------ | ----- |
@@ -197,7 +197,7 @@ There are two fields that can be updated for a team: `name` and `email`.
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ----------- | -------- |
@@ -240,7 +240,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ------------ | -------- |
@@ -277,7 +277,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ---------------------- | -------- |
@@ -330,7 +330,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ----------------------- | -------- |
@@ -372,7 +372,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ----------------------- | -------- |
@@ -412,7 +412,7 @@ Will override all current members and administrators for the specified team.
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ----------------------- | -------- |
@@ -455,7 +455,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ---------- | -------- |
@@ -489,7 +489,7 @@ Content-Type: application/json
**Required permissions**
See note in the [introduction]({{< ref "#team-api" >}}) for an explanation.
See note in the [introduction](#team-api) for an explanation.
| Action | Scope |
| ----------- | -------- |
docs/sources/developers/http_api/team_sync.md
+5 -5
View File
@@ -23,9 +23,9 @@ title: Team Sync HTTP API
# Team Sync API
> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}).
> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/).
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
## Get External Groups
@@ -33,7 +33,7 @@ title: Team Sync HTTP API
**Required permissions**
See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation.
See note in the [introduction](#external-group-synchronization-api) for an explanation.
| Action | Scope |
| ---------------------- | -------- |
@@ -75,7 +75,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation.
See note in the [introduction](#external-group-synchronization-api) for an explanation.
| Action | Scope |
| ----------------------- | -------- |
@@ -117,7 +117,7 @@ Status Codes:
**Required permissions**
See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation.
See note in the [introduction](#external-group-synchronization-api) for an explanation.
| Action | Scope |
| ----------------------- | -------- |