opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 04:02:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/http_api/_index.md
Jack Baldry 7eb17bccca Explicitly set all front matter labels in the source files (#71548) 
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

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

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

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

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

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

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

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

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

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

* Fix introduction pages products

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

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

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

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

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

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

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

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00

2.9 KiB
Raw Blame History

aliases canonical description keywords labels title weight
../http_api/
../overview/
/docs/grafana/latest/developers/http_api/ Grafana HTTP API
grafana
http
documentation
api
overview
products
enterprise
oss
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.

Since version 8.4, HTTP API details are specified using OpenAPI v2.

Starting from version 9.1, there is also a OpenAPI v3 specification (generated by the v2 one).

Users can browser and try out both via the Swagger UI editor (served by the grafana server) by navigating to /swagger-ui and /openapi3 respectively.

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/" >}})
  • [Team sync API]({{< relref "team_sync/" >}})
  • [License API]({{< relref "licensing/" >}})
  • [Reporting API]({{< relref "reporting/" >}})
  • [Query and resource caching API]({{< relref "query_and_resource_caching/" >}})