Get Folders

Get Folders

Get all folders within the current organization

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/folders
COPY
Query Parameters
string
apiVersion
Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

integer
$top
Optional

Number of records you want to get.

integer
$skip
Optional

Number of records you want to skip.

boolean
$count
Optional

Flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.

string
$select
Optional

Select a subset of properties to include in the response.

string
$filter
Optional

Filter the results by a specified predicate expression. Operators: eq, ne, and, or.

string
cloudAccountId
Optional

The ID of a vcenter cloud account.

string
externalRegionId
Optional

The external unique identifier of the region associated with the vcenter cloud account.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns FolderResult of type(s) application/json 
{
    "content": [
        {
            "id": "9.0E49",
            "createdAt": "2012-09-27",
            "updatedAt": "2012-09-27",
            "owner": "[email protected]",
            "ownerType": "ad_group",
            "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
            "_links": {
                "empty": false
            },
            "name": "my-name",
            "description": "my-description",
            "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
            "customProperties": {
                "folderType": "1"
            },
            "cloudAccountIds": [
                "[ \"cloud-account-id-1\", \"cloud-account-id-2\" } ]"
            ]
        }
    ],
    "totalElements": 1,
    "numberOfElements": 1
}
array of object
content
Optional

List of content items

integer As int64 As int64
totalElements
Optional

Total number of elements. In some cases the field may not be populated

integer As int64 As int64
numberOfElements
Optional

Number of elements in the current page


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/iaas/api/folders?apiVersion=v
On This Page
Folders Operations
GET
Get Folders