GRgrafana
dashboards

Create / Update dashboard

Creates a new dashboard or updates an existing dashboard. Note: This endpoint is not intended for creating folders, use POST /api/folders for that.

Use: /apis/dashboard.grafana.app/v1/namespaces/{ns}/dashboards

post/dashboards/db

Request

  • Base URL
    /api (relative, and the document’s source URL is not known)
  • URL
    /api/dashboards/db
  • Auth
    • HTTP basic
    • or API key in header Authorization

Request body

UpdatedAtstring date-time
dashboardJson
folderIdinteger

Deprecated: use FolderUID instead

folderUidstring
isFolderboolean
messagestring
overwriteboolean
userIdinteger

Response

(empty)

folderUidstring

FolderUID The unique identifier (uid) of the folder the dashboard belongs to.

idinteger required

ID The unique identifier (id) of the created/updated dashboard.

statusstring required

Status status of the response.

titlestring required

Slug The slug of the dashboard.

uidstring required

UID The unique identifier (uid) of the created/updated dashboard.

urlstring required

URL The relative URL for accessing the created/updated dashboard.

versioninteger required

Version The version of the dashboard.

Example response

{
  "id": 1,
  "status": "success",
  "title": "my-dashboard",
  "uid": "nHz3SXiiz",
  "url": "/d/nHz3SXiiz/my-dashboard",
  "version": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.