This is an archive version of the document. To get the most up-to-date information, see the current version.Get Amazon S3 Bucket Folder Data
You can get data on an Amazon S3 bucket folder with the specified name.
Request
To retrieve information on a specific folder, send the HTTP GET request to the /cloudInfrastructure/buckets/{bucketId}/folders/{folderName} 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/cloudInfrastructure/buckets/{bucketId}/folders/{folderName} |
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 data on the specified folder in the Amazon S3 bucket. The BucketFolder schema is used for the resource representation.
Example
The following request returns specific information on the usdept05-repository folder in an Amazon S3 bucket with the ID 02741a4e-34d4-4809-8e99-560cfeb7f6d7.
|