diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e4c3dd91b79..843ba61a2f6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -65,7 +65,6 @@ pages: - ['reference/plugins.md', 'Reference', 'Plugins'] - ['reference/export_import.md', 'Reference', 'Import & Export'] - ['reference/admin.md', 'Reference', 'Administration'] -- ['reference/http_api.md', 'Reference', 'HTTP API'] - ['reference/keyboard_shortcuts.md', 'Reference', 'Keyboard Shortcuts'] - ['datasources/overview.md', 'Data Sources', 'Overview'] @@ -77,6 +76,15 @@ pages: - ['datasources/kairosdb.md', 'Data Sources', 'KairosDB'] - ['datasources/prometheus.md', 'Data Sources', 'Prometheus'] +- ['http_api/first_steps.md', 'HTTP API', 'Authentication API'] +- ['http_api/dashboards.md', 'HTTP API', 'Dashboards API'] +- ['http_api/data_sources.md', 'HTTP API', 'Data Sources API'] +- ['http_api/orgs.md', 'HTTP API', 'Organisations API'] +- ['http_api/users.md', 'HTTP API', 'Users API'] +- ['http_api/admin.md', 'HTTP API', 'Admin API'] +- ['http_api/snapshots.md', 'HTTP API', 'Snapshots API'] +- ['http_api/general.md', 'HTTP API', 'Other API'] + - ['tutorials/index.md', 'Tutorials', 'Tutorials'] - ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana'] diff --git a/docs/sources/http_api/first_steps.md b/docs/sources/http_api/first_steps.md index 0fbdf348327..2c63077a8f1 100644 --- a/docs/sources/http_api/first_steps.md +++ b/docs/sources/http_api/first_steps.md @@ -1,21 +1,19 @@ ---- -page_title: HTTP API +page_title: Authentication API page_description: Grafana HTTP API Reference page_keywords: grafana, admin, http, api, documentation --- -# HTTP API Reference +# Authentication API The Grafana backend exposes an HTTP API, the same API is used by the frontend to do everything from saving dashboards, creating users and updating data sources. -## Authorization - -### Tokens +## Tokens Currently you can authenticate via an `API Token` or via a `Session cookie` (acquired using regular login or oauth). -### Basic Auth +## Basic Auth If basic auth is enabled (it is enabled by default) you can authenticate your HTTP request via standard basic auth. @@ -26,7 +24,7 @@ curl example: {"id":1,"name":"Main Org."} ``` -### Create API Token +## Create API Token Open the sidemenu and click the organization dropdown and select the `API Keys` option. @@ -40,4 +38,4 @@ You use the token in all requests in the `Authorization` header, like this: Accept: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk -The `Authorization` header value should be `Bearer <your api key>`. \ No newline at end of file +The `Authorization` header value should be `Bearer <your api key>`. diff --git a/docs/sources/installation/migrating_to2.md b/docs/sources/installation/migrating_to2.md index 497b53e77e2..aebe4a83788 100644 --- a/docs/sources/installation/migrating_to2.md +++ b/docs/sources/installation/migrating_to2.md @@ -20,7 +20,7 @@ migrate to Grafana 2.0. ## Adding Data sources The `config.js` file has been deprecated. Data sources are now managed via -the UI or [HTTP API](../reference/http_api.md). Manage your +the UI or [HTTP API](../http_api/first_steps.md). Manage your organizations data sources by clicking on the `Data Sources` menu on the side menu (which can be toggled via the Grafana icon in the upper left of your browser).