Browse Datastore
Browse 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.
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
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
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
Define desired sort by field of the result data. If order_by is not specified, ascending is used as default.
nameDefine desired sort order by field of the result data. Must be used in combination with sort_by. Supported values: asc, ascending, desc, descending.
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.
10The 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
10Search criteria to browse the datastore
{
"query_type": "string",
"browse_path": "string",
"sub_folders": false
}query_type
The path of the datastore to browse, pass an empty string for the root node.
Whether the datastore that the file system searches should include subfolders of the browse path.
List of files and folders in the datastore, based on a search criteria
{
"list": [
{
"name": "string",
"path": "string",
"size": 0,
"file_type": "string"
}
],
"_meta": {
"errors": [
{
"code": "string",
"message": "string",
"field": "string"
}
],
"total": 0,
"offset": 0,
"limit": 0,
"links": {
"next": {
"href": "string"
},
"self": {
"href": "string"
},
"previous": {
"href": "string"
}
}
}
}Bad request - the server could not understand the request due to invalid syntax or invalid request body content
{
"error_code": "string",
"message": "string",
"op_id": "string"
}error_code
message
op_id
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
{
"error_code": "string",
"message": "string",
"op_id": "string"
}error_code
message
op_id
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request
{
"error_code": "string",
"message": "string",
"op_id": "string"
}error_code
message
op_id