Getting Folders
You can get a list of Amazon folders created in the specified bucket.
Request
GET https://<hostname>:4443/v6/S3Resources/buckets/{bucketName}/folders?accountId=<string>&RegionType=<string> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
bucketName | string | Specifies the bucket name. For more information on how to get this parameter, see Getting Buckets. |
accountId | string | Specifies the identification number of a cloud account. For more information on how to get this parameter, see Getting Accounts. |
RegionType | string | Specifies a region type. The following types are available:
|
The following optional parameter can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
Name | string | Specifies a folder name. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /S3Resources/buckets/{bucketName}/folders resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
path | string | Specifies a folder path. |
name | string | Specifies a folder name. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a list of Amazon folders created in the Bucket5 bucket by the specified cloud account in the region with the Global region type.
Request: GET https://abc.tech.local:4443/v6/S3Resources/buckets/Bucket5/folders?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "path": "Veeam/Backup365/Folder1/", "name": "Folder1", "links": { "self": { "href": "/v6/S3Resources/buckets/Bucket5/folders/Folder1?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionType=Global" }, "account": { "href": "/v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7" }, "bucket": { "href": "/v6/S3Resources/buckets/Bucket5?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global" } } }, { "path": "Veeam/Backup365/Folder2/", "name": "Folder2", "links": { "self": { "href": "/v6/S3Resources/buckets/Bucket5/folders/Folder2?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionType=Global" }, "account": { "href": "/v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7" }, "bucket": { "href": "/v6/S3Resources/buckets/Bucket5?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global" } } }, ... ] |