mirror of
https://github.com/grafana/grafana.git
synced 2025-09-17 03:12:54 +08:00
Fix all the old usage of admonition syntax (#106984)
This commit is contained in:
@ -203,9 +203,9 @@ Content-Type: application/json
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
|
||||
|
||||
## Password for User
|
||||
|
||||
|
||||
`PUT /api/admin/users/:id/password`
|
||||
|
||||
Only works with Basic Authentication (username and password). See [introduction](/docs/grafana/<GRAFANA_VERSION>/http_api/admin/#admin-api) for an explanation.
|
||||
|
@ -24,11 +24,11 @@ refs:
|
||||
|
||||
# Shared Dashboards API
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
|
||||
If you're running Grafana Enterprise, you'll need to have specific permissions for some endpoints. Refer to [Role-based access control permissions](ref:role-based-access-control-permissions) for more information.
|
||||
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
## Create a shared dashboard
|
||||
|
||||
|
@ -25,9 +25,9 @@ title: Data source HTTP API
|
||||
|
||||
`GET /api/datasources`
|
||||
|
||||
{{% admonition type="warning" %}}
|
||||
{{< admonition type="warning" >}}
|
||||
This API currently doesn't handle pagination. The default maximum number of data sources returned is 5000. You can change this value in the default.ini file.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
**Required permissions**
|
||||
|
||||
@ -84,9 +84,9 @@ Content-Type: application/json
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
|
||||
|
||||
```http
|
||||
HTTP/1.1 200
|
||||
HTTP/1.1 200
|
||||
Content-Type: application/json
|
||||
|
||||
```
|
||||
@ -351,9 +351,9 @@ Content-Type: application/json
|
||||
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
```
|
||||
|
||||
**Example Response**:
|
||||
**Example Response**:
|
||||
|
||||
```http
|
||||
```http
|
||||
HTTP/1.1 200
|
||||
Content-Type: application/json
|
||||
|
||||
@ -440,9 +440,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
|
||||
## Check data source health by id
|
||||
|
||||
> **Warning:** This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source health check API](#check-data-source-health).
|
||||
|
||||
|
||||
`GET /api/datasources/:datasourceId/health`
|
||||
|
||||
|
||||
Makes a call to the health endpoint of data source identified by the given `datasourceId`. This is not mandatory - every plugin author has to <a href="https://grafana.com/tutorials/build-a-data-source-backend-plugin/#add-support-for-health-checks" target="_blank">implement support for health checks</a> in their plugin themselves.
|
||||
|
||||
### Examples
|
||||
@ -519,9 +519,9 @@ Content-Type: application/json
|
||||
```
|
||||
|
||||
## Fetch data source resources
|
||||
|
||||
|
||||
`GET /api/datasources/uid/:uid/resources/*`
|
||||
|
||||
|
||||
Makes a call to the resources endpoint of data source identified by the given `uid`.
|
||||
|
||||
### Examples
|
||||
@ -603,17 +603,17 @@ Content-Type: application/json
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"values": [
|
||||
"values": [
|
||||
[1644488152084, 1644488212084, 1644488272084, 1644488332084, 1644488392084, 1644488452084],
|
||||
[1, 20, 90, 30, 5, 0]
|
||||
[1, 20, 90, 30, 5, 0]
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
#### Status codes
|
||||
|
||||
@ -715,9 +715,9 @@ Content-Type: application/json
|
||||
|
||||
## Data source proxy calls by id
|
||||
|
||||
{{% admonition type="warning" %}}
|
||||
{{< admonition type="warning" >}}
|
||||
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source API for proxying requests](#data-source-proxy-calls).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
`GET /api/datasources/proxy/:datasourceId/*`
|
||||
|
||||
@ -791,9 +791,9 @@ Content-Type: application/json
|
||||
|
||||
## Fetch data source resources by id
|
||||
|
||||
{{% admonition type="warning" %}}
|
||||
{{< admonition type="warning" >}}
|
||||
This API is deprecated since Grafana v9.0.0 and will be removed in a future release. Refer to the [new data source resources API](#fetch-data-source-resources).
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
`GET /api/datasources/:datasourceId/resources/*`
|
||||
|
||||
@ -893,9 +893,9 @@ Queries a data source having a backend implementation.
|
||||
|
||||
`POST /api/ds/query`
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Grafana's built-in data sources usually have a backend implementation.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
**Example request for the Test data source**:
|
||||
|
||||
|
@ -441,9 +441,9 @@ Status Codes:
|
||||
|
||||
Deletes an existing library element as specified by the UID. This operation cannot be reverted.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
You cannot delete a library element that is connected. This operation cannot be reverted.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
**Example Request**:
|
||||
|
||||
|
@ -75,9 +75,9 @@ Status codes:
|
||||
## Add license
|
||||
|
||||
{{< admonition type="note" >}}
|
||||
Available in Grafana Enterprise v7.4+.
|
||||
Available in Grafana Enterprise v7.4+.
|
||||
{{< /admonition >}}
|
||||
|
||||
|
||||
`POST /api/licensing/token`
|
||||
|
||||
Applies a license to a Grafana instance.
|
||||
@ -151,9 +151,9 @@ Status Codes:
|
||||
|
||||
{}
|
||||
```
|
||||
|
||||
|
||||
**Example response:**
|
||||
|
||||
|
||||
```http
|
||||
HTTP/1.1 200 OK
|
||||
Content-Type: application/json
|
||||
@ -212,9 +212,9 @@ Status Codes:
|
||||
Content-Type: application/json
|
||||
Content-Length: 2
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
Status codes:
|
||||
Status codes:
|
||||
|
||||
- **202** - Accepted, license removed or did not exist.
|
||||
- **401** - Unauthorized
|
||||
|
@ -23,9 +23,9 @@ title: Query and Resource Caching HTTP API
|
||||
|
||||
# Query and resource caching API
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< 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](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
## Enable caching for a data source
|
||||
|
||||
|
@ -69,9 +69,9 @@ JSON Body schema:
|
||||
- **key** - Optional. Define the unique key. Required if **external** is `true`.
|
||||
- **deleteKey** - Optional. Unique key used to delete the snapshot. It is different from the **key** so that only the creator can delete the snapshot. Required if **external** is `true`.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
When creating a snapshot using the API, you have to provide the full dashboard payload including the snapshot data. This endpoint is designed for the Grafana UI.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
**Example Response**:
|
||||
|
||||
|
@ -22,9 +22,9 @@ title: 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](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
{{< admonition type="note" >}}
|
||||
Available since Grafana 11. SAML support is in public preview behind the `ssoSettingsSAML` feature flag.
|
||||
{{% /admonition %}}
|
||||
{{< /admonition >}}
|
||||
|
||||
The API can be used to create, update, delete, get, and list SSO Settings for OAuth2 and SAML.
|
||||
|
||||
@ -167,11 +167,11 @@ Grafana verifies whether the given settings are allowed and valid.
|
||||
- **403** – Access Denied
|
||||
|
||||
## Delete SSO Settings
|
||||
|
||||
|
||||
`DELETE /api/v1/sso-settings/:provider`
|
||||
|
||||
Deletes an existing SSO Settings entry for a provider.
|
||||
|
||||
|
||||
**Required permissions**
|
||||
|
||||
See note in the [introduction](#sso-settings) for an explanation.
|
||||
|
Reference in New Issue
Block a user