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

[v10.3.x] Replace docs/reference shortcode with ref URIs (#88379)

Browse Source
This commit is contained in:
Jack Baldry
2024-05-28 20:37:27 +01:00
committed by GitHub
parent 253b4333c4
commit b0816100eb
176 changed files with 3815 additions and 2773 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/developers/http_api/alerting.md
+13 -10
View File
@@ -15,6 +15,17 @@ labels:
- enterprise
- oss
title: Legacy Alerting API
refs:
admin-api:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/developers/http_api/admin/#pause-all-alerts
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/developers/http_api/admin/#pause-all-alerts
grafana-alerting-alerts-documentation:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/
---
# Legacy Alerting API
@@ -27,7 +38,7 @@ This topic is relevant for the [legacy dashboard alerts](/docs/grafana/v8.5/aler
If you are using Grafana Alerting, refer to [Alerting provisioning API]({{< relref "./alerting_provisioning" >}})
You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation][] for details on how to create and manage new alerts.
You can find Grafana Alerting API specification details [here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/grafana/grafana/main/pkg/services/ngalert/api/tooling/post.json). Also, refer to [Grafana Alerting alerts documentation](ref:grafana-alerting-alerts-documentation) for details on how to create and manage new alerts.
You can use the Alerting API to get information about legacy dashboard alerts and their states but this API cannot be used to modify the alert.
To create new alerts or modify them you need to update the dashboard JSON that contains the alerts.
@@ -173,12 +184,4 @@ Content-Type: application/json
## Pause all alerts
See [Admin API][].
{{% docs/reference %}}
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Admin API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/admin#pause-all-alerts"
[Grafana Alerting alerts documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
[Grafana Alerting alerts documentation]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/alerting"
{{% /docs/reference %}}
See [Admin API](ref:admin-api).
docs/sources/developers/http_api/dashboard_public.md
+7 -6
View File
@@ -14,13 +14,19 @@ labels:
- enterprise
- oss
title: Public Dashboard HTTP API
refs:
role-based-access-control-permissions:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/
---
# Public Dashboard API
{{% 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][] for more information.
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 %}}
@@ -317,8 +323,3 @@ Content-Type: application/json
"perPage": 2
}
```
{{% docs/reference %}}
[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}
docs/sources/developers/http_api/user.md
+7 -6
View File
@@ -14,6 +14,12 @@ labels:
- enterprise
- oss
title: User HTTP API
refs:
role-based-access-control-permissions:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes/
---
# User API
@@ -24,7 +30,7 @@ user must have the Grafana Admin role.
API Tokens can be used with Organization HTTP API to get users of specific organization.
> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions][] 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](ref:role-based-access-control-permissions) for more information.
## Search Users
@@ -683,8 +689,3 @@ Content-Type: application/json
"message": "User auth token revoked"
}
```
{{% docs/reference %}}
[Role-based access control permissions]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
[Role-based access control permissions]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/roles-and-permissions/access-control/custom-role-actions-scopes"
{{% /docs/reference %}}