Veeam Backup for Microsoft 365 8
REST API Reference
Related documents

S3 Compatible Object Storage Buckets and Folders

The /S3CompatibleResources resource collection represents S3 Compatible, IBM Cloud or Wasabi Cloud object storage buckets and folders.

Get Buckets

Returns a list of S3 Compatible, IBM Cloud or Wasabi Cloud object storage buckets.

SecurityBearer
Request
query Parameters
accountId
required
string <uuid>

Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.

ServicePoint
required
string

Specifies an endpoint address.

CustomRegionId
required
string

Specifies a region ID.

Name
string

Specifies a bucket name. To filter objects, you can use * and ? wildcard characters.

trustedServerCertificateThumbprint
string

Specifies a thumbprint of a not trusted S3 Compatible self-signed certificate.

trustServerCertificate
boolean

Defines whether to trust S3 Compatible self-signed certificates. If set to true, you can omit specifying the TrustedServerCertificateThumbprint parameter value.

Responses
200

OK

default

Operation failure response.

get/v8/S3CompatibleResources/buckets
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Bucket by Name
Returns information about S3 Compatible, IBM Cloud or Wasabi Cloud object storage bucket with the specified name.


SecurityBearer 
Request 
path Parameters
Name
required
string
Specifies the bucket name. For more information on how to get this parameter, see Get Buckets.


 
query Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
ServicePoint
required
string
Specifies an endpoint address.


 
CustomRegionId
required
string
Specifies a region ID.


 
trustedServerCertificateThumbprint
string
Specifies a thumbprint of a not trusted S3 Compatible self-signed certificate.


 
trustServerCertificate
boolean
Defines whether to trust S3 Compatible self-signed certificates. If set to true, you can omit specifying the TrustedServerCertificateThumbprint parameter value.


 
Responses 
200
OK


default
Operation failure response.


get/v8/S3CompatibleResources/buckets/{Name}
Request samples 
Response samples 
application/json
{
  • "servicePoint": "string",
  • "customRegionId": "string",
  • "name": "string",
  • "_links": {
    }
}
Get Folders
Returns a list of S3 Compatible, IBM Cloud or Wasabi Cloud object storage folders created in the specified bucket.


SecurityBearer 
Request 
path Parameters
bucketName
required
string
Specifies the bucket name. For more information on how to get this parameter, see Get Buckets.


 
query Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
ServicePoint
required
string
Specifies an endpoint address.


 
CustomRegionId
required
string
Specifies a region ID.


 
Name
string
Specifies the folder name. To filter objects, you can use * and ? wildcard characters.


 
trustedServerCertificateThumbprint
string
Specifies a thumbprint of a not trusted S3 Compatible self-signed certificate.


 
trustServerCertificate
boolean
Defines whether to trust S3 Compatible self-signed certificates. If set to true, you can omit specifying the TrustedServerCertificateThumbprint parameter value.


 
Responses 
200
OK


default
Operation failure response.


get/v8/S3CompatibleResources/buckets/{bucketName}/folders
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create Folders
Creates a new folder in the specified S3 Compatible, IBM Cloud or Wasabi Cloud object storage bucket.


x-codegen-request-body-name:  folderJson
SecurityBearer 
Request 
path Parameters
bucketName
required
string
Specifies the bucket name. For more information on how to get this parameter, see Get Buckets.


 
query Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
ServicePoint
required
string
Specifies an endpoint address.


 
CustomRegionId
required
string
Specifies a region ID.


 
trustedServerCertificateThumbprint
string
Specifies a thumbprint of a not trusted S3 Compatible self-signed certificate.


 
trustServerCertificate
boolean
Defines whether to trust S3 Compatible self-signed certificates. If set to true, you can omit specifying the TrustedServerCertificateThumbprint parameter value.


 
Request Body schema: application/json
required
name
string
Specifies a name for a new folder.


 
object (RESTLinkHALDictionary) 
Related resources.


 
Responses 
201
Created


default
Operation failure response.


post/v8/S3CompatibleResources/buckets/{bucketName}/folders
Request samples 
application/json
{
  • "name": "string",
  • "_links": {
    }
}
Response samples 
application/json
{
  • "path": "string",
  • "name": "string",
  • "_links": {
    }
}
Get Folder by Name
Returns information about S3 Compatible, IBM Cloud or Wasabi Cloud object storage folder with the specified name.


SecurityBearer 
Request 
path Parameters
Name
required
string
Specifies the folder name. For more information on how to get this parameter, see Get Folders.


 
bucketName
required
string
Specifies the bucket name. For more information on how to get this parameter, see Get Buckets.


 
query Parameters
accountId
required
string <uuid> 
Specifies the identification number of the cloud account. For more information on how to get this parameter, see Get Accounts.


 
ServicePoint
required
string
Specifies an endpoint address.


 
CustomRegionId
required
string
Specifies a region ID.


 
trustedServerCertificateThumbprint
string
Specifies a thumbprint of a not trusted S3 Compatible self-signed certificate.


 
trustServerCertificate
boolean
Defines whether to trust S3 Compatible self-signed certificates. If set to true, you can omit specifying the TrustedServerCertificateThumbprint parameter value.


 
Responses 
200
OK


default
Operation failure response.


get/v8/S3CompatibleResources/buckets/{bucketName}/folders/{Name}
Request samples 
Response samples 
application/json
{
  • "path": "string",
  • "name": "string",
  • "_links": {
    }
}

    
    

                                

                                    
Document updated 12/18/2025
Page content applies to build 8.3.0.2201