Getting Buckets
You can get a list of S3 Compatible or IBM object storage buckets.
|
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?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 |
|---|---|---|
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 bucket 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 resource. The response body contains the following properties:
Property | Type | Description |
|---|---|---|
servicePoint | string | Specifies the endpoint address. |
customRegionId | string | Specifies the region ID. |
name | string | Specifies the bucket name. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example returns a list of S3 Compatible buckets created by the specified cloud account.
Request: GET https://abc.tech.local:4443/v6/S3CompatibleResources/buckets?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: [ { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "S3CompatibleBucket1", "links": { "self": { "href": "v6/S3CompatibleResources/buckets/S3CompatibleBucket1?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" } } }, { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "S3CompatibleBucket2", "links": { "self": { "href": "v6/S3CompatibleResources/buckets/S3CompatibleBucket2?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" } } }, { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "S3CompatibleBucket3", "links": { "self": { "href": "v6/S3CompatibleResources/buckets/S3CompatibleBucket3?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" } } }, ... ] |