Delete a dashboard

DELETE 
/perses-public/api/v1/projects/:projectId/dashboards/:dashboardId

Deletes a dashboard. The deletion is soft: the dashboard stops appearing in every endpoint of this API, and its stored versions are retained internally.

Request

Path Parameters

projectId stringrequired

The id of the folder that contains the dashboard.

dashboardId stringrequired

The dashboard's uid.

Responses

200

The dashboard was deleted. This endpoint returns 200 with a body, not 204. The id is the deleted version row, not the dashboard's uid.

application/json

Schema

Schema

id string

Example (from schema)

{
  "id": "7d1e5a90-2b44-4c18-9f03-5a6b7c8d9e01"
}

401

The API token is missing or invalid.

application/json

Schema

Schema

statusCode integer
message string
requestId string

Quote this when contacting support about a failed request.

errorCode string

Null for most dashboard errors.

parameters object

Extra context for the error, when there is any.

Example (from schema)

{
  "statusCode": 400,
  "message": "Dashboard name is required",
  "requestId": "string",
  "errorCode": "string",
  "parameters": {}
}

404

No such dashboard in that folder.

application/json

Schema

Schema

statusCode integer
message string
requestId string

Quote this when contacting support about a failed request.

errorCode string

Null for most dashboard errors.

parameters object

Extra context for the error, when there is any.

Example (from schema)

{
  "statusCode": 400,
  "message": "Dashboard name is required",
  "requestId": "string",
  "errorCode": "string",
  "parameters": {}
}

Loading...