Delete dashboard folder

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

Deletes a folder and every dashboard inside it. Deleting a folder that still has dashboards in it also succeeds - there is no "folder is not empty" guard.

The deletion is soft: the folder and its dashboards stop appearing in every endpoint of this API. Creating a folder with the same metadata.name later restores this one.

Request

Path Parameters

projectId stringrequired

The folder's id.

Responses

200

The folder was deleted. This endpoint returns 200 with a body, not 204.

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 folder in this account.

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...