postEnvironmentDirectorycontents
Gets the contents of a given directory in the file system
Requires authentication as administrator
postEnvironmentDirectorycontents
Request
post /Environment/DirectoryContentsParameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *Path | query | |||
| IncludeFiles | query | An optional filter to include or exclude files from the results. true/false |
||
| IncludeDirectories | query | An optional filter to include or exclude folders from the results. true/false |
||
| *body | body | GetDirectoryContents | GetDirectoryContents |
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 | FileSystemEntryInfo [] | Operation successful. Returning a List
|
|
| 400 | Bad Request. Server cannot process request. |
||
| 401 | Unauthorized. Client needs to authenticate. |
||
| 403 | Forbidden. No permission for the reqested operation. |
||
| 404 | Resource not found or unavailable. |
||
| 500 | Server error. |
Definitions
GetDirectoryContents
Emby.Api.GetDirectoryContents
| Name | Type | Notes |
|---|---|---|
| Username | string | |
| Password | string |
FileSystemEntryInfo
| Name | Type | Notes |
|---|---|---|
| Name | string | The name. |
| Path | string | The path. |
| Type | FileSystemEntryType | Enum FileSystemEntryType |
FileSystemEntryType
Enum Values
- File
- Directory
- NetworkComputer
- NetworkShare