From f96a7461b26cbb838db2d1f3daf68d2b9590fad4 Mon Sep 17 00:00:00 2001 From: "grafana-delivery-bot[bot]" <132647405+grafana-delivery-bot[bot]@users.noreply.github.com> Date: Thu, 29 May 2025 09:29:31 +0200 Subject: [PATCH] [release-12.0.2] Fixing links and removing duplicate content (#106194) Co-authored-by: Zach Day Fixing links and removing duplicate content (#105837) --- docs/sources/developers/http_api/dashboard.md | 103 +----------------- 1 file changed, 5 insertions(+), 98 deletions(-) diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index 21400aae528..b862fb7c4a6 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -474,7 +474,7 @@ Status Codes: Updates an existing dashboard via the dashboard uid. -- namespace: to read more about the namespace to use, see the [API overview]({{< ref "apis" >}}). +- namespace: to read more about the namespace to use, see the [API overview](https://grafana.com/docs/grafana//developers/http_api/apis/). - uid: the unique identifier of the dashboard to update. this will be the _name_ in the dashboard response **Required permissions** @@ -565,7 +565,7 @@ Status Codes: Gets a dashboard via the dashboard uid. -- namespace: to read more about the namespace to use, see the [API overview]({{< ref "apis" >}}). +- namespace: to read more about the namespace to use, see the [API overview](https://grafana.com/docs/grafana//developers/http_api/apis/). - uid: the unique identifier of the dashboard to update. this will be the _name_ in the dashboard response Note: For large dashboards, add `/dto` to the end of the URL to get the full dashboard body. @@ -634,9 +634,7 @@ Status Codes: Lists all dashboards in the given organization. You can control the maximum number of dashboards returned through the `limit` query parameter. You can then use the `continue` token returned to fetch the next page of dashboards. -- namespace: to read more about the namespace to use, see the [API overview]({{< ref "apis" >}}). - -Note: to read more about the namespace to use, see the [API overview]({{< ref "apis" >}}). +- namespace: to read more about the namespace to use, see the [API overview](https://grafana.com/docs/grafana//developers/http_api/apis/). **Required permissions** @@ -713,7 +711,7 @@ Status Codes: Deletes a dashboard via the dashboard uid. -- namespace: to read more about the namespace to use, see the [API overview]({{< ref "apis" >}}). +- namespace: to read more about the namespace to use, see the [API overview](https://grafana.com/docs/grafana//developers/http_api/apis/). - uid: the unique identifier of the dashboard to update. this will be the _name_ in the dashboard response **Required permissions** @@ -853,7 +851,7 @@ Content-Type: application/json ## Dashboard Search -See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}}). +See [Folder/Dashboard Search API](../folder_dashboard_search/). ## APIs @@ -1096,94 +1094,3 @@ Status Codes: - **401** – Unauthorized - **403** – Access denied - **404** – Not found - -## Gets the home dashboard - -`GET /api/dashboards/home` - -Will return the home dashboard. - -**Example Request**: - -```http -GET /api/dashboards/home HTTP/1.1 -Accept: application/json -Content-Type: application/json -Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk -``` - -**Example Response**: - -```http -HTTP/1.1 200 -Content-Type: application/json - -{ - "dashboard": { - "editable":false, - "nav":[ - { - "enable":false, - "type":"timepicker" - } - ], - "style":"dark", - "tags":[], - "templating":{ - "list":[ - ] - }, - "time":{ - }, - "timezone":"browser", - "title":"Home", - "version":5 - }, - "meta": { - "isHome":true, - "canSave":false, - "canEdit":false, - "canStar":false, - "url":"", - "expires":"0001-01-01T00:00:00Z", - "created":"0001-01-01T00:00:00Z" - } -} -``` - -## Tags for Dashboard - -`GET /api/dashboards/tags` - -Get all tags of dashboards - -**Example Request**: - -```http -GET /api/dashboards/tags HTTP/1.1 -Accept: application/json -Content-Type: application/json -Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk -``` - -**Example Response**: - -```http -HTTP/1.1 200 -Content-Type: application/json - -[ - { - "term":"tag1", - "count":1 - }, - { - "term":"tag2", - "count":4 - } -] -``` - -## Dashboard Search - -See [Folder/Dashboard Search API](../folder_dashboard_search/).