Browse Datastore
DescriptionBrowse the datastore that is defined in the URL by its ID. This API returns files that reside on the given datastore. These files are filtered based on the given search criteria.
Request
URLURL
Path Parameters
Path Parameters
The ID of the pairing between this vSphere Replication server and the remote one.
The ID of the vCenter server
The ID of a datastore
Query Parameters
Query Parameters
The filter value by which to filter the result data. Must be used in combination with filter_prop parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1&filter=vm-2
The name of the field by which to filter the result data. Must be used in combination with filter parameter. Supports for nested fields. Example: https://dr-server/api/vms?filter_property=name&filter=vm-1
Specify the limit size of the result data. In combination with offset parameter provides paging functionality. If none - configuration property ‘defaultResponsePageSize’ in REST API configuration file is taken into account. If configuration property is not defined - default value of 100 is taken into account.
limit example
"10"
The amount of elements to skip in the response. In combination with limit parameter provides paging functionality. Must be used in combination with limit parameter. If none - default value of 0 is taken into account. Example: https://dr-server/api/vms?limit=10&offset=10
offset example
"10"
Define desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.
Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.
sort_by example
"name"
Request Body
Search criteria to browse the datastore
{
"browse_path": "string",
"query_type": "VM_DISK",
"sub_folders": false
}
The path of the datastore to browse, pass an empty string for the root node.
The datastore browser query type.
Possible values are: VM_DISK , FLOPPY_IMAGE , ISO_IMAGE , VM_CONFIG_FILES , ALL_FILES , FOLDERS
Indicate whether the datastore that the file system searches should include subfolders of the browse path.
Authentication
Response
Response BodyResponse Body
200 OK
List of files and folders in the datastore, based on a search criteria.
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"limit": 0,
"links": {
"next": {
"href": "string"
},
"previous": {
"href": "string"
},
"self": {
"href": "string"
}
},
"offset": 0,
"total": 0
},
"list": [
{
"file_type": "FOLDER",
"name": "string",
"path": "string",
"size": 0
}
]
}
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
x-dr-permissions:
permissions:
- System.View
- System.Read
- Datastore.Browse
x-dr-remote-site-connectivity-contract:
not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
server-down: DEPENDS_ON_PROVIDED_PARAMS
