NFnforgeio
folders

Delete folder.

Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted. If nested folders are enabled then it also deletes all the subfolders.

delete/folders/{folder_uid}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders/{folder_uid}
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

folder_uidstring required

Query parameters

forceDeleteRulesboolean

If true any Grafana 8 Alerts under this folder will be deleted. Set to false so that the request will fail if the folder contains any Grafana 8 Alerts.

Response

(empty)

idinteger required

ID Identifier of the deleted folder.

messagestring required

Message Message of the deleted folder.

titlestring required

Title of the deleted folder.

Example response

{
  "id": 65,
  "message": "Folder My Folder deleted",
  "title": "My Folder"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.