Folders: remove get by id from docs (#97069)

This commit is contained in:
Stephanie Hingtgen 2024-11-26 18:12:07 -07:00 committed by GitHub
parent 5fadc35664
commit 72ffe9838a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -342,61 +342,6 @@ Status Codes:
- **403** Access Denied - **403** Access Denied
- **404** Folder not found - **404** Folder not found
## Get folder by id
`GET /api/folders/id/:id`
Will return the folder identified by id.
This is deprecated. Use [get folder by UID]({{< ref "#get-folder-by-uid" >}}) instead.
**Required permissions**
See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation.
| Action | Scope |
| -------------- | ----------- |
| `folders:read` | `folders:*` |
**Example Request**:
```http
GET /api/folders/id/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
```
**Example Response**:
```http
HTTP/1.1 200
Content-Type: application/json
{
"id":1,
"uid": "nErXDvCkzz",
"title": "Department ABC",
"url": "/dashboards/f/nErXDvCkzz/department-abc",
"hasAcl": false,
"canSave": true,
"canEdit": true,
"canAdmin": true,
"createdBy": "admin",
"created": "2018-01-31T17:43:12+01:00",
"updatedBy": "admin",
"updated": "2018-01-31T17:43:12+01:00",
"version": 1
}
```
Status Codes:
- **200** Found
- **401** Unauthorized
- **403** Access Denied
- **404** Folder not found
## Move folder ## Move folder
`POST /api/folders/:uid/move` `POST /api/folders/:uid/move`