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

Remove relref shortcodes (#101694)

Browse Source 
* manually replce all shared relrefs

* relref replace - grafana next

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

* manual fixes

* remove ref shortcode

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

* prettier

* fix test

* update readme
This commit is contained in:
Robby Milo
2025-03-06 13:59:08 +01:00
committed by GitHub
parent a604602b55
commit 13cf67de53
176 changed files with 1522 additions and 1536 deletions
Download Patch File Download Diff File Expand all files Collapse all files
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
Content-Type: application/json
```
## Get a single data source by uid
`GET /api/datasources/uid/:uid`
@@ -146,7 +146,7 @@ Content-Type: application/json
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
@@ -202,7 +202,7 @@ Content-Type: application/json
```http
POST /api/datasources HTTP/1.1
Accept: application/json
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
@@ -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
`PUT /api/datasources/uid/:uid`
**Required permissions**
**Required permissions**
See note in the [introduction](#data-source-api) for an explanation.
@@ -446,7 +446,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele
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
**Example Request**:
```http
@@ -529,7 +529,7 @@ Similar to [creating a data source](#create-a-data-source), `password` and `basi
**Example Request**:
```http
GET api/datasources/uid/P8045C56BDA891CB2/resources/dimension-keys?region=us-east-2&namespace=AWS%2FEC2&dimensionFilters=%7B%7D&metricName=CPUUtilization HTTP/1.1
GET api/datasources/uid/P8045C56BDA891CB2/resources/dimension-keys?region=us-east-2&namespace=AWS%2FEC2&dimensionFilters=%7B%7D&metricName=CPUUtilization HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
@@ -617,7 +617,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele
#### Status codes
| Code | Description |
| Code | Description |
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200 | All data source queries returned a successful response. |
| 400 | Bad request due to invalid JSON, missing content type, missing or invalid fields, etc. Or one or more data source queries were unsuccessful. Refer to the body for more details. |
@@ -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 |
| ------------------ | ---------------------------------------------------------------------------------------------- |