List Folder
DescriptionReturns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Folder.FilterSpec.
Request
URLURL
https://{api_host}/rest/vcenter/folder
Query Parameters
Query Parameters
filter
Optional
Specification of matching folders for which information should be returned.
If unset, the behavior is equivalent to a Folder.FilterSpec with all fields unset which means all folders match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
FolderListResponseBody
of type application/json
Commonly used information about the folders matching the Folder.FilterSpec.
{
"value": [
{
"folder": "string",
"name": "string",
"type": "enum"
}
]
}
array of
FolderSummary
value
Optional
Commonly used information about the folders matching the Folder.FilterSpec.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/folder
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Folder.FilterSpec.type field contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1000 folders match the Folder.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
