This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Folders

You can get a list of S3 Compatible or IBM object storage folders created in the specified bucket.

Getting Folders Note

If an object storage uses a self-signed SSL certificate, you must add this certificate to the trusted root of the server that runs Veeam Backup for Microsoft 365 REST API service. Otherwise, this method will not work.

Request

GET https://<hostname>:4443/v6/S3CompatibleResources/buckets/{bucketName}/folders?accountId=<string>&ServicePoint=<string>&CustomRegionId=<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.
ServicePoint	string	Specifies an endpoint address.
CustomRegionId	string	Specifies a region ID.

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 /S3CompatibleResources/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 S3 Compatible object storage folders created in the specified bucket by the specified cloud account.

Request:

GET https://abc.tech.local:4443/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

[

{

"path": "Veeam/Backup365/Folder1/",

"name": "Folder1",

"links": {

"self": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/Folder1?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

"account": {

"href": "/v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c"

"bucket": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

}

{

"path": "Veeam/Backup365/Folder2/",

"name": "Folder2",

"links": {

"self": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/Folder2?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

"account": {

"href": "/v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c"

"bucket": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

}

{

"path": "Veeam/Backup365/Folder3/",

"name": "Folder31",

"links": {

"self": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/Folder3?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

"account": {

"href": "/v6/accounts/ed531412-7646-4fa1-bea5-986c04bcb89c"

"bucket": {

"href": "/v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1"

}

...

]