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 16:48:00 +01:00
committed by GitHub
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/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:
```http
HTTP/1.1 200
Content-Type: application/json
Content-Type: application/json
```
## Delete global User
## Delete global User
`DELETE /api/admin/users/:id`
@@ -307,7 +307,7 @@ Content-Type: application/json
**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 |
| -------------------- | --------------- |
@@ -345,11 +345,11 @@ Content-Type: application/json
| Action | Scope |
| --------------------- | --------------- |
| users.authtoken:write | global.users:\* |
**Example Request**:
```http
POST /api/admin/users/1/revoke-auth-token HTTP/1.1
POST /api/admin/users/1/revoke-auth-token HTTP/1.1
Accept: application/json
Content-Type: application/json
@@ -371,7 +371,7 @@ Content-Type: application/json
and will be required to authenticate again upon next activity.
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](#admin-api) for an explanation.
@@ -386,12 +386,12 @@ Content-Type: application/json
POST /api/admin/users/1/logout HTTP/1.1
Accept: application/json
Content-Type: application/json
```
```
**Example Response**:
```http
HTTP/1.1 200
HTTP/1.1 200
Content-Type: application/json
```
@@ -420,11 +420,11 @@ Content-Type: application/json
| Action | Scope | Provision entity |
| ------------------- | -------------------------- | ---------------- |
| provisioning:reload | provisioners:accesscontrol | accesscontrol |
| provisioning:reload | provisioners:accesscontrol | accesscontrol |
| provisioning:reload | provisioners:dashboards | dashboards |
| provisioning:reload | provisioners:datasources | datasources |
| provisioning:reload | provisioners:plugins | plugins |
| provisioning:reload | provisioners:alerting | alerting |
| provisioning:reload | provisioners:alerting | alerting |
**Example Request**:
@@ -453,11 +453,11 @@ Content-Type: application/json
**Example Request**:
```http
POST /api/admin/ldap/reload HTTP/1.1
POST /api/admin/ldap/reload HTTP/1.1
Accept: application/json
Content-Type: application/json
```
**Example Response**:
```http
@@ -486,11 +486,11 @@ Content-Type: application/json
HTTP/1.1 204
Content-Type: application/json
```
## Re-encrypt data encryption keys
`POST /api/admin/encryption/reencrypt-data-keys`
[Re-encrypts](../../../setup-grafana/configure-security/configure-database-encryption/#re-encrypt-data-keys) data encryption keys.
**Example Request**:
@@ -545,11 +545,11 @@ Content-Type: application/json
**Example Response**:
```http
```http
HTTP/1.1 204
Content-Type: application/json
```
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**: