Getting Object Storage Repositories
You can get a list of all object storage repositories added to Veeam Backup for Microsoft 365.
Request
GET https://<hostname>:4443/v6/objectstoragerepositories/?longTerm=<boolean> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following optional parameter can be specified in the URL of the request:
Parameter | Type | Description |
---|---|---|
longTerm | boolean | Defines the representation of the object storage repository properties that will be returned to the client. The following values are available:
|
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 /objectstoragerepositories collection resource. The response body contains the following properties:
Property | Type | Description |
---|---|---|
azureContainer/amazonBucketS3Aws/amazonBucketS3Compatible | The following data types are available depending on the storage type: | Contains a container or bucket definition. |
azureFolder/s3Folder | string | Specifies storage folder where backups reside. |
id | string | Specifies the object storage ID. |
name | string | Specifies the object storage name. |
description | string | Specifies the object storage description. |
accountId | string | Specifies ID of the account under which the object storage was added. |
sizeLimitEnabled | boolean | Defines whether the size limit is set. |
sizeLimitGB | integer | Specifies size limit in GB. |
usedSpaceBytes | integer | Specifies used space in Bytes. |
freeSpaceBytes | integer | Specifies free space in Bytes. |
type | string | Specifies the object storage type. The following types are available:
|
glacierDeepArchiveEnabled | boolean | Defines that the Amazon S3 Glacier Deep Archive storage class is enabled. |
iaStorageClassEnabled | boolean | Defines that the Amazon S3 Standard-Infrequent Access storage class is enabled for data blocks that are stored in an Amazon S3 object storage. |
useArchiverAppliance | boolean | Defines that Veeam Backup for Microsoft 365 uses the Amazon or Azure archiver appliance when transferring backed-up data to the archive object storage. |
amazonArchiverAppliance/azureArchiverAppliance | The following properties of archiver appliance are available depending on the archiver appliance type: | Contains a definition of the Amazon archiver appliance or Azure archiver appliance that Veeam Backup for Microsoft 365 uses when transferring backed-up data to the archive object storage. |
azureServiceAccount | Specifies properties of the Microsoft Azure service account that the Azure archiver appliance uses to access Microsoft Azure. | |
azureSubscription | Specifies properties of the Microsoft Azure subscription associated with a user account that is used to access Azure Blob storage. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
---|---|---|
name | string | Specifies a container name. |
regionType | string | Specifies a region type. The following types are available:
|
Property | Type | Description |
---|---|---|
regionType | string | Specifies a region type. The following types are available:
|
regionName | string | Specifies a region name. |
regionId | string | Specifies a region ID. |
name | string | Specifies a bucket name. |
Property | Type | Description |
---|---|---|
servicePoint | string | Specifies an endpoint address. |
customRegionId | string | Specifies a region ID. |
name | string | Specifies a bucket name. |
Property | Type | Description |
---|---|---|
instanceType | Specifies an instance type that the Amazon archiver appliance uses. | |
virtualPrivateCloud | Specifies Amazon Virtual Private Cloud (Amazon VPC). | |
subnet | Specifies the Amazon archiver appliance subnet. | |
securityGroup | Specifies a security group associated with the Amazon archiver appliance. | |
appliancePort | integer | Specifies a port number that is used to route requests between the Amazon archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components. |
Property | Type | Description |
---|---|---|
virtualMachineSize | Specifies the Azure archiver appliance size. | |
resourceGroup | Specifies a resource group associated with the Azure archiver appliance. | |
virtualNetwork | Specifies a virtual network to which the Azure archiver appliance is connected. | |
subnet | Specifies the Azure archiver appliance subnet. | |
region | string | Specifies a Microsoft Azure region. |
appliancePort | integer | Specifies a port number that is used to route requests between the Azure archiver appliance and Veeam Backup for Microsoft 365 backup infrastructure components. |
Example
The example returns a resource representation of all repositories created on a backup proxy.
Request: GET https://abc.tech.local:4443/v6/objectstoragerepositories/
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: [ { "s3Folder": "AmazonS3Folder1", "id": "793c212d-5a9f-409e-a6f6-299fd84a82bf", "name": "Amazon Archive Object Storage", "description": "", "accountId": "c0f030cb-a43a-4713-8da8-717c62a0b4f7", "sizeLimitEnabled": false, "usedSpaceBytes": 19918723665, "type": "AmazonS3Glacier", "_links": { "self": { "href": "v6/objectstoragerepositories/793c212d-5a9f-409e-a6f6-299fd84a82bf" }, "account": { "href": "v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7" }, "bucket": { "href": "v6/S3Resources/buckets/test_bucket?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global&RegionId=us-east-2" }, "folder": { "href": "v6/S3Resources/buckets/test_bucket/folders/AmazonS3Folder1?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionType=Global" } }, "glacierDeepArchiveEnabled": false, "amazonBucketS3Aws": { "regionType": "Global", "regionName": "US East (Ohio)", "regionId": "us-east-2", "name": "test_bucket" }, "iaStorageClassEnabled": false, "useArchiverAppliance": true, "amazonArchiverAppliance": { "instanceType": { "cores": 0, "memory": 0 }, "virtualPrivateCloud": {}, "subnet": {}, "securityGroup": {}, "appliancePort": 0 } }, { "id": "838cd507-76ff-4074-a707-e5fa38f5b348", "name": "Azure Object Storage", "description": "", "accountId": "b59af548-3406-4681-a56b-3dfc6c379e96", "sizeLimitEnabled": false, "usedSpaceBytes": 64416891671, "type": "AzureBlob", "_links": { "self": { "href": "v6/objectstoragerepositories/838cd507-76ff-4074-a707-e5fa38f5b348" }, "account": { "href": "v6/accounts/b59af548-3406-4681-a56b-3dfc6c379e96" }, "container": { "href": "v6/AzureResources/containers/container1?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&RegionType=Global" }, "folder": { "href": "v6/AzureResources/containers/container1/folders/AzureFolder?accountId=b59af548-3406-4681-a56b-3dfc6c379e96®ionType=Global" } }, "useArchiverAppliance": false, "azureContainer": { "name": "container1", "regionType": "Global" }, "azureFolder": "AzureFolder" }, { "id": "ffb0076b-b049-4034-aeb2-ec4d1ebc6fab", "name": "Azure Archive Object Storage", "description": "", "accountId": "b59af548-3406-4681-a56b-3dfc6c379e96", "sizeLimitEnabled": false, "usedSpaceBytes": 19407424423, "type": "AzureBlobArchive", "_links": { "self": { "href": "v6/objectstoragerepositories/ffb0076b-b049-4034-aeb2-ec4d1ebc6fab" }, "account": { "href": "v6/accounts/b59af548-3406-4681-a56b-3dfc6c379e96" }, "container": { "href": "v6/AzureResources/containers/container1?accountId=b59af548-3406-4681-a56b-3dfc6c379e96&RegionType=Global" }, "folder": { "href": "v6/AzureResources/containers/container1/folders/AzureArchiveFolder?accountId=b59af548-3406-4681-a56b-3dfc6c379e96®ionType=Global" } }, "useArchiverAppliance": false, "azureContainer": { "name": "container1", "regionType": "Global" }, "azureFolder": "AzureArchiveFolder" }, { "amazonBucketS3Compatible": { "servicePoint": "https://my.servicepoint.com:443", "customRegionId": "us-east-1", "name": "d3e020df-9144-4fa3-a2ff-a83abb3f7cfa" }, "s3Folder": "S3CompatibleFolder", "id": "ca324d07-60a8-4504-879d-0913a379b4b3", "name": "S3 Compatible", "description": "", "accountId": "ed531412-7646-4fa1-bea5-986c04bcb89c", "sizeLimitEnabled": true, "sizeLimitGB": 1024, "usedSpaceBytes": 0, "freeSpaceBytes": 1099511627776, "type": "AmazonS3Compatible", "_links": { "self": { "href": "v6/objectstoragerepositories/ca324d07-60a8-4504-879d-0913a379b4b3" }, "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" }, "folder": { "href": "v6/S3CompatibleResources/buckets/d3e020df-9144-4fa3-a2ff-a83abb3f7cfa/folders/S3CompatibleFolder?accountId=ed531412-7646-4fa1-bea5-986c04bcb89c&ServicePoint=https://my.servicepoint.com:443&CustomRegionId=us-east-1" } } }, { "s3Folder": "AmazonS3Folder2", "id": "54a791d7-46b1-4725-8f7a-f9504c26cf38", "name": "Amazon S3 Object Storage", "description": "", "accountId": "c0f030cb-a43a-4713-8da8-717c62a0b4f7", "sizeLimitEnabled": false, "usedSpaceBytes": 0, "type": "AmazonS3", "_links": { "self": { "href": "v6/objectstoragerepositories/54a791d7-46b1-4725-8f7a-f9504c26cf38" }, "account": { "href": "v6/accounts/c0f030cb-a43a-4713-8da8-717c62a0b4f7" }, "bucket": { "href": "v6/S3Resources/buckets/test_bucket?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7&RegionType=Global&RegionId=us-east-2" }, "folder": { "href": "v6/S3Resources/buckets/test_bucket/folders/AmazonS3Folder2?accountId=c0f030cb-a43a-4713-8da8-717c62a0b4f7®ionType=Global" } }, "amazonBucketS3Aws": { "regionType": "Global", "regionName": "US East (Ohio)", "regionId": "us-east-2", "name": "test_bucket" }, "iaStorageClassEnabled": false, "useArchiverAppliance": true, "amazonArchiverAppliance": { "instanceType": { "cores": 0, "memory": 0 }, "virtualPrivateCloud": {}, "subnet": {}, "securityGroup": {}, "appliancePort": 0 } } ] |