Vcenter Folder list

Vcenter Folder list

Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the Vcenter Folder FilterSpec.

Request
URI
GET
https://{api_host}/api/vcenter/folder
COPY
Query Parameters
Vcenter Folder FilterSpec
filter
Optional

Specification of matching folders for which information should be returned.

If missing or null, the behavior is equivalent to a Vcenter Folder FilterSpec with all properties missing or null which means all folders match the filter.

string of array
folders
Optional

Identifiers of folders that can match the filter.

If missing or null or empty, folders with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array
names
Optional

Names that folders must have to match the filter (see Vcenter Folder Summary.name).

If missing or null or empty, folders with any name match the filter.

string of array
parent_folders
Optional

Folders that must contain the folder for the folder to match the filter.

If missing or null or empty, folder in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array
datacenters
Optional

Datacenters that must contain the folder for the folder to match the filter.

If missing or null or empty, folder in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

Authentication
This operation uses the following authentication methods.
Responses
200

Commonly used information about the folders matching the Vcenter Folder FilterSpec.

[
    "Vcenter Folder Summary Object"
]
array of Vcenter Folder Summary
Optional

400

if the Vcenter Folder FilterSpec.type property contains a value that is not supported by the server.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

500

if more than 1000 folders match the Vcenter Folder FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0 
"Vapi Std Errors UnableToAllocateResource Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0 
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/folder
On This Page
Vcenter Operations
GET
Vcenter Folder list