grafana/docs/sources/developers/http_api/_index.md
Jack Baldry c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove aliases from shared pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Rewrite all current latest aliases to be next

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in latest alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00

2.2 KiB

aliases description keywords title weight
../http_api/
../overview/
Grafana HTTP API
grafana
http
documentation
api
overview
HTTP API 100

HTTP API reference

The Grafana backend exposes an HTTP API, which is the same API that is used by the frontend to do everything from saving dashboards, creating users, and updating data sources.

HTTP APIs

  • [Admin API]({{< relref "admin/" >}})
  • Alerting API (unstable)
  • [Alerting Provisioning API]({{< relref "alerting_provisioning/" >}})
  • [Annotations API]({{< relref "annotations/" >}})
  • [Authentication API]({{< relref "auth/" >}})
  • [Correlations API]({{< relref "correlations/" >}})
  • [Dashboard API]({{< relref "dashboard/" >}})
  • [Dashboard Permissions API]({{< relref "dashboard_permissions/" >}})
  • [Dashboard Versions API]({{< relref "dashboard_versions/" >}})
  • [Data source API]({{< relref "data_source/" >}})
  • [Folder API]({{< relref "folder/" >}})
  • [Folder Permissions API]({{< relref "folder_permissions/" >}})
  • [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}})
  • [Library Element API]({{< relref "library_element/" >}})
  • [Organization API]({{< relref "org/" >}})
  • [Other API]({{< relref "other/" >}})
  • [Playlists API]({{< relref "playlist/" >}})
  • [Preferences API]({{< relref "preferences/" >}})
  • [Short URL API]({{< relref "short_url/" >}})
  • [Query history API]({{< relref "query_history/" >}})
  • [Snapshot API]({{< relref "snapshot/" >}})
  • [Team API]({{< relref "team/" >}})
  • [User API]({{< relref "user/" >}})

Deprecated HTTP APIs

  • [Alerting Notification Channels API]({{< relref "alerting_notification_channels/" >}})
  • [Alerting API]({{< relref "alerting/" >}})

Grafana Enterprise HTTP APIs

Grafana Enterprise includes all of the Grafana OSS APIs as well as those that follow:

  • [Role-based access control API]({{< relref "access_control/" >}})
  • [Data source permissions API]({{< relref "datasource_permissions/" >}})
  • [External group sync API]({{< relref "external_group_sync/" >}})
  • [License API]({{< relref "licensing/" >}})
  • [Reporting API]({{< relref "reporting/" >}})