Getting Folders
This section explains how to get a list of Amazon folders.
Request
GET https://<hostname>:4443/v5/S3Resources/buckets/{bucketName}/folders?accountId=<accountId>®ionType=<regionType>&name=<name> |
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 | The name of the bucket. |
accountId | string | An identification number of the account under which you can connect to object storage. |
regionType | string | A region type of object storage. |
name | string | The 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
Property | Type | Description |
|---|---|---|
path | string | A folder path. |
name | string | A folder name. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
Request: GET /v5/S3Resources/buckets/veeam-tw/folders?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a®ionType=Global
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [{ "path": "Veeam/Backup365/Amazon Backups/", "name": "Amazon Backups", "links": { "self": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw/folders/Amazon Backups?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a®ionType=Global"}, "account": {"href": "https://abc.tech.local:4443/v5/accounts/de4f0671-953c-4f88-a60f-731bc8277e3a"}, "bucket": {"href": "https://abc.tech.local:4443/v5/S3Resources/buckets/veeam-tw?accountId=de4f0671-953c-4f88-a60f-731bc8277e3a&RegionType=Global"} } }] |