This is an archive version of the document. To get the most up-to-date information, see the current version.Get Amazon S3 Bucket Folders of Amazon Connection
You can get a list of all Amazon S3 buckets folders to which the IAM role of a specific amazon connection has permissions.
Request
To retrieve a representation of a collection of Amazon S3 bucket folders, send the HTTP GET request to the /amazonConnections/{amazonConnectionId}/browseBucketFolders endpoint. {amazonConnectionId} is a system ID assigned to the amazon connection in the Veeam Backup for AWS REST API.
The bucketId parameter must be sent as part of the URL. Use the question mark (?) to separate the parameter from the endpoint. {bucketId} is a system ID assigned to the Amazon S3 bucket in the Veeam Backup for AWS REST API.
HTTP Request
GET https://<hostname>:<port>/api/v1/amazonConnections/{amazonConnectionId}/browseBucketFolders?bucketId={bucketId} |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
Sort |
| Specifies the order of items in the response. For more information, see Sort Parameter. |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Response
The server returns the following response to the client.
Response Code
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 HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns a list of Amazon S3 bucket folders of the amazon connection with the specified ID. The BucketFolder schema is used for the collection representation.
Example
The following request returns a full list of folders in an Amazon S3 bucket with the ID 67eea526-fa06-4010-865f-4f4801ee5154 to which has permissions the IAM role of an amazon connection with the ID 5cb4509e-ded8-41e6-812f-d0cc217a7d62.
|