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

Fix all the old usage of admonition syntax (#107098)

Browse Source
This commit is contained in:
Jack Baldry
2025-06-27 11:28:14 +01:00
committed by GitHub
parent 7307a2bdbe
commit a113d04fb9
161 changed files with 721 additions and 721 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/data_source.md
+20 -20
View File
@@ -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
`GET /api/datasources/:datasourceId`
{{% 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 [API for getting a single data source by UID](#get-a-single-data-source-by-uid) or to the [API for getting a single data source by its name](#get-a-single-data-source-by-name).
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -351,9 +351,9 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
By defining `password` and `basicAuthPassword` under `secureJsonData` Grafana encrypts them securely as an encrypted blob in the database. The response then lists the encrypted fields under `secureJsonFields`.
{{% /admonition %}}
{{< /admonition >}}
**Example Graphite Request with basic auth enabled**:
@@ -440,9 +440,9 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
`PUT /api/datasources/:datasourceId`
{{% 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 update API](#update-an-existing-data-source).
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -519,9 +519,9 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response.
{{% /admonition %}}
{{< /admonition >}}
## Update an existing data source
@@ -603,17 +603,17 @@ Content-Type: application/json
}
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Similar to [creating a data source](#create-a-data-source), `password` and `basicAuthPassword` should be defined under `secureJsonData` in order to be stored securely as an encrypted blob in the database. Then, the encrypted fields are listed under `secureJsonFields` section in the response.
{{% /admonition %}}
{{< /admonition >}}
## Delete an existing data source by id
`DELETE /api/datasources/:datasourceId`
{{% 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 [API for deleting an existing data source by UID](#delete-an-existing-data-source-by-uid) or to the [API for deleting an existing data source by its name](#delete-an-existing-data-source-by-name)
{{% /admonition %}}
{{< /admonition >}}
**Required permissions**
@@ -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**: