IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
104c4a7630
grafana/docs/sources/developers/http_api/_index.md

55 lines
2.0 KiB
Markdown
Raw Normal View History

Convert TOML front matter to YAML (#49690) Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-05-26 10:06:25 -05:00
---
aliases:
- /docs/grafana/latest/developers/http_api/
- /docs/grafana/latest/http_api/
- /docs/grafana/latest/overview/
description: Grafana HTTP API
keywords:
- grafana
- http
- documentation
- api
- overview
title: HTTP API
weight: 100
---
docs(http): moves overview content to /http_api/ ref #6719
2016-11-27 10:09:47 -06:00
Use sentence case for consistency: (#40285) For example, https://grafana.com/docs/grafana/next/http_api/access_control/ uses sentence case and the link text is inconsistent.
2021-10-28 12:26:23 -05:00
# HTTP API reference
docs(http): moves overview content to /http_api/ ref #6719
2016-11-27 10:09:47 -06:00
Use sentence case for consistency: (#40285) For example, https://grafana.com/docs/grafana/next/http_api/access_control/ uses sentence case and the link text is inconsistent.
2021-10-28 12:26:23 -05:00
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.
docs(http): moves overview content to /http_api/ ref #6719
2016-11-27 10:09:47 -06:00
Docs: Update HTTP API index page to make clear that GE API includes everything OSS (#34269)
2021-05-20 05:38:05 -05:00
## HTTP APIs
Docs: Refactor inconsistent unordered lists (#27826) * Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 13:02:11 -05:00
Docs: add API pages to HTTP API list (#42997) * add API pages to HTTP API list * fix capitalization of page names
2022-01-21 09:19:11 -06:00
- [Admin API]({{< relref "admin.md" >}})
- [Alerting Notification Channels API]({{< relref "alerting_notification_channels.md" >}})
- [Alerting API]({{< relref "alerting.md" >}})
- [Annotations API]({{< relref "annotations.md" >}})
Docs: Refactor inconsistent unordered lists (#27826) * Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 13:02:11 -05:00
- [Authentication API]({{< relref "auth.md" >}})
- [Dashboard API]({{< relref "dashboard.md" >}})
Docs: add API pages to HTTP API list (#42997) * add API pages to HTTP API list * fix capitalization of page names
2022-01-21 09:19:11 -06:00
- [Dashboard Permissions API]({{< relref "dashboard_permissions.md" >}})
- [Dashboard Versions API]({{< relref "dashboard_versions.md" >}})
Use sentence case for consistency: (#40285) For example, https://grafana.com/docs/grafana/next/http_api/access_control/ uses sentence case and the link text is inconsistent.
2021-10-28 12:26:23 -05:00
- [Data source API]({{< relref "data_source.md" >}})
Docs: add API pages to HTTP API list (#42997) * add API pages to HTTP API list * fix capitalization of page names
2022-01-21 09:19:11 -06:00
- [Folder API]({{< relref "folder.md" >}})
- [Folder Permissions API]({{< relref "folder_permissions.md" >}})
- [Folder/Dashboard Search API]({{< relref "folder_dashboard_search.md" >}})
- [Library Element API]({{< relref "library_element.md" >}})
Docs: Refactor inconsistent unordered lists (#27826) * Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 13:02:11 -05:00
- [Organization API]({{< relref "org.md" >}})
Docs: add API pages to HTTP API list (#42997) * add API pages to HTTP API list * fix capitalization of page names
2022-01-21 09:19:11 -06:00
- [Other API]({{< relref "other.md" >}})
Docs: Refactor inconsistent unordered lists (#27826) * Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 13:02:11 -05:00
- [Playlists API]({{< relref "playlist.md" >}})
- [Preferences API]({{< relref "preferences.md" >}})
Docs: add API pages to HTTP API list (#42997) * add API pages to HTTP API list * fix capitalization of page names
2022-01-21 09:19:11 -06:00
- [Short URL API]({{< relref "short_url.md" >}})
- [Snapshot API]({{< relref "snapshot.md" >}})
- [Team API]({{< relref "team.md" >}})
Bug: Fixed User API Link (#44342) Very minor fix to complete the User API link.
2022-01-22 23:33:50 -06:00
- [User API]({{< relref "user.md" >}})
Docs: misc. nitpicks to the HTTP API docs (#21758) * Replace bash/json with http in http_api codeblocks Since http is used elsewhere on the API docs and makes the markdown rendering look different on the blocks that use bash/json * Fix the annotations API link on 'Features' - Noticed the Features/Dashboard Features/Annotations link pointing to the HTTP API was linking itself instead of '../http_api/annotations.md'. - Also add a link on Dashboard Export and Import to its HTTP API. * Add missing links to features in API Index Noticed there was 3 missing references in the API docs index. - https://grafana.com/docs/grafana/latest/http_api/playlist - https://grafana.com/docs/grafana/latest/http_api/datasource_permissions - https://grafana.com/docs/grafana/latest/http_api/external_group_sync Last two are Grafana Enterprise -only, so created a separate subsection for them.
2020-01-27 06:41:15 -06:00
Docs: Update HTTP API index page to make clear that GE API includes everything OSS (#34269)
2021-05-20 05:38:05 -05:00
## Grafana Enterprise HTTP APIs
Grafana Enterprise includes all of the Grafana OSS APIs as well as those that follow:
Docs: misc. nitpicks to the HTTP API docs (#21758) * Replace bash/json with http in http_api codeblocks Since http is used elsewhere on the API docs and makes the markdown rendering look different on the blocks that use bash/json * Fix the annotations API link on 'Features' - Noticed the Features/Dashboard Features/Annotations link pointing to the HTTP API was linking itself instead of '../http_api/annotations.md'. - Also add a link on Dashboard Export and Import to its HTTP API. * Add missing links to features in API Index Noticed there was 3 missing references in the API docs index. - https://grafana.com/docs/grafana/latest/http_api/playlist - https://grafana.com/docs/grafana/latest/http_api/datasource_permissions - https://grafana.com/docs/grafana/latest/http_api/external_group_sync Last two are Grafana Enterprise -only, so created a separate subsection for them.
2020-01-27 06:41:15 -06:00
Docs: Fine-grained access control refactor (#47536) * fleshing out About topic * docs, fgac refactor initial draft * updated FGAC with service account details * finalized restructure * make prettier, corrects spelling * fixes typo * adds rollout strategy topic * started name change * renamed to rbac throughout docs * copy edit to about and actions and scopes docs * finishes content reorg * draft of refactored refactored docs * corrects relrefs * formatting tweaks * fixes typo * copy updates to about rbac * rbac rollout docs edits * update rbac role assignment docs * content update to manage rbac roles doc * sort and reorder roles reference in rbac docs * alphabetize permissions table * Update docs/sources/enterprise/settings-updates.md Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com> * incorporates feedback, makes prettier * update http api references in rbac docs * fix broken refs and improve wording on enabling RBAC provisioning Co-authored-by: eleijonmarck <eric.leijonmarck@gmail.com> Co-authored-by: Mitchel Seaman <mitchel.seaman@gmail.com> Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
2022-04-27 09:51:56 -05:00
- [Role-based access control API]({{< relref "access_control.md" >}})
Use sentence case for consistency: (#40285) For example, https://grafana.com/docs/grafana/next/http_api/access_control/ uses sentence case and the link text is inconsistent.
2021-10-28 12:26:23 -05:00
- [Data source permissions API]({{< relref "datasource_permissions.md" >}})
- [External group sync API]({{< relref "external_group_sync.md" >}})
Fixed some formatting issues for PRs from yesterday. (#33078)
2021-04-16 11:35:49 -05:00
- [License API]({{< relref "licensing.md" >}})
Docs: Refactor inconsistent unordered lists (#27826) * Docs: Refactor inconsistent unordered lists * add requested changes * Update docs/sources/linking/data-link-variables.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/http_api/_index.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/guides/whats-new-in-v6-0.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * resolve weird line breaks * revert unintentional change * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Update docs/sources/auth/auth-proxy.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
2020-10-02 13:02:11 -05:00
- [Reporting API]({{< relref "reporting.md" >}})
Reference in New Issue Copy Permalink