{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Folders API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Folders", "type": "folder" }, "items": [ { "info": { "name": "List all folders", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "List all folders" }, { "info": { "name": "Create a folder", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/folders", "body": { "type": "json", "data": "{}" } }, "docs": "Create a folder" }, { "info": { "name": "Get folder by UID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders/:uid", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Get folder by UID" }, { "info": { "name": "Update folder", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/folders/:uid", "params": [ { "name": "uid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update folder" }, { "info": { "name": "Delete folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/folders/:uid", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "Delete folder" }, { "info": { "name": "Grafana Get Folder By ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders/id/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path" } ] }, "docs": "The GET /folders/id/{folder_id} endpoint in Grafana retrieves detailed information about a specific folder using its unique identifier. This operation allows users to fetch folder metadata including its title, UID, permissions, and other configuration details by providing the numeric folder ID in the path parameter. It's particularly useful when you need to access folder information programmatically and have the folder's ID rather than its UID, returning a JSON response with the complete folder " }, { "info": { "name": "Grafana Get Folder By UID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders/:folder_uid", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves detailed information about a specific Grafana folder by providing its unique identifier (UID). By making a GET request to the endpoint with the folder's UID as a path parameter, users can fetch metadata about the folder including its title, UID, ID, URL, version, and other configuration details. This is useful for programmatically accessing folder properties, verifying folder existence, or gathering information needed for subsequent operations such as dashboard manag" }, { "info": { "name": "Grafana Update Folder", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/folders/:folder_uid", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing folder in Grafana identified by its unique folder UID. This PUT operation allows you to modify folder properties such as the folder's title, and optionally update the folder's version for optimistic concurrency control. The request requires authentication and appropriate permissions to modify the specified folder. Upon successful execution, it returns the updated folder object with its current metadata including the new title, UID, ID, URL, and updated version number. This op" }, { "info": { "name": "Grafana Delete Folder", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/folders/:folder_uid", "params": [ { "name": "folder_uid", "value": "", "type": "path" }, { "name": "forceDeleteRules", "value": "", "type": "query", "description": "If `true` any Grafana 8 Alerts under this folder will be deleted.\nSet to `false` so that the request will fail if the folder contains any Grafana 8 Alerts." } ] }, "docs": "This API operation deletes a specific folder in Grafana by providing its unique identifier (folder_uid) in the request path. When executed, it permanently removes the folder and potentially all its contents from the Grafana instance, which may include dashboards, alerts, and other resources stored within that folder. The operation requires appropriate permissions to delete folders and returns a confirmation response upon successful deletion, though the exact behavior regarding cascade deletion o" }, { "info": { "name": "Grafana Get Folder Descendant Counts", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders/:folder_uid/counts", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ] }, "docs": "Returns statistical information about the descendants of a specified folder in Grafana, identified by its unique folder UID. This endpoint retrieves count data for various types of resources that exist within the folder hierarchy, such as dashboards, alerts, and other nested folders, providing administrators and users with a quick overview of the folder's contents without needing to traverse the entire folder structure manually." }, { "info": { "name": "Grafana Move Folder", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/folders/:folder_uid/move", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation moves a Grafana folder identified by its unique identifier (folder_uid) to a new location within the folder hierarchy. It uses a POST request to the /folders/{folder_uid}/move endpoint and allows administrators to reorganize their Grafana folder structure by changing a folder's parent or position. The operation requires the folder_uid path parameter to specify which folder to move, and typically accepts a request body containing the destination folder information or new parent" }, { "info": { "name": "Grafana Get Folder Permission List", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/folders/:folder_uid/permissions", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves the complete list of permissions associated with a specific folder in Grafana by providing the folder's unique identifier (UID) in the request path. It returns details about which users, teams, or roles have access to the folder and what level of permissions they possess, such as view, edit, or admin rights. This GET endpoint is useful for auditing folder access controls, understanding the current permission structure, and determining who has what level of access to " }, { "info": { "name": "Grafana Update Folder Permissions", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/folders/:folder_uid/permissions", "params": [ { "name": "folder_uid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to modify the access permissions for a specific folder in Grafana by making a POST request to the endpoint with the folder's unique identifier (UID). You can use it to grant or revoke permissions for users, teams, or roles, controlling who can view, edit, or administer the folder and its contents. The request body typically includes permission items specifying the permission level (viewer, editor, or admin) and the entity being granted access (user ID, team ID, or r" } ] } ], "bundled": true }