Products: Managed Backup (Agent)
Article ID: m0683Last Modified: 10-Dec-2024
POST API/Accounts/CreateDestination
Create a destination bucket for existing storage accounts.
Request Information
URI Parameters
None.
Body Parameters
Structure of destination bucket
Name | Description | Type | Additional Information |
---|---|---|---|
AccountID | Storage Account ID | Globally Unique Identifier | Required |
DisplayName | Destination Display Name | string | Required |
DestinationSettings | Destination settings | StorageDestinationSettings | None |
Request Formats
application/json, text/json
{
"AccountID": "d6ee821a-facc-4258-8e8c-e1da4ed8a30e",
"DisplayName": "sample string 2",
"DestinationSettings": {
"GoogleCloudPlatform": {
"StorageClass": 0,
"RegionalLocation": 0,
"BucketName": "sample string 1",
"UseImmutability": true
},
"AmazonS3": {
"UseS3TransferAcceleration": true,
"Region": "sample string 2",
"BucketName": "sample string 3",
"UseImmutability": true
},
"Wasabi": {
"Region": "sample string 1",
"BucketName": "sample string 2",
"UseImmutability": true
},
"S3Compatible": {
"BucketName": "sample string 1",
"UseImmutability": true
},
"Azure": {
"BucketName": "sample string 1",
"UseImmutability": true
},
"B2": {
"BucketName": "sample string 1",
"UseImmutability": true
}
}
}
application/xml, text/xml
<AccountDestinationCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
<AccountID>d6ee821a-facc-4258-8e8c-e1da4ed8a30e</AccountID>
<DestinationSettings>
<AmazonS3>
<BucketName>sample string 3</BucketName>
<UseImmutability>true</UseImmutability>
<Region>sample string 2</Region>
<UseS3TransferAcceleration>true</UseS3TransferAcceleration>
</AmazonS3>
<Azure>
<BucketName>sample string 1</BucketName>
<UseImmutability>true</UseImmutability>
</Azure>
<B2>
<BucketName>sample string 1</BucketName>
<UseImmutability>true</UseImmutability>
</B2>
<GoogleCloudPlatform>
<BucketName>sample string 1</BucketName>
<UseImmutability>true</UseImmutability>
<RegionalLocation>US</RegionalLocation>
<StorageClass>STANDARD</StorageClass>
</GoogleCloudPlatform>
<S3Compatible>
<BucketName>sample string 1</BucketName>
<UseImmutability>true</UseImmutability>
</S3Compatible>
<Wasabi>
<BucketName>sample string 2</BucketName>
<UseImmutability>true</UseImmutability>
<Region>sample string 1</Region>
</Wasabi>
</DestinationSettings>
<DisplayName>sample string 2</DisplayName>
</AccountDestinationCreateModel>
Response Information
Resource Description: DestinationOfAccount
Storage account destination model
Name | Description | Type | Additional Information |
---|---|---|---|
DestinationID | Destination ID | Globally Unique Identifier | Required |
AccountID | Storage Account ID | Globally Unique Identifier | Required |
Destination | Destination Display Name | string | Required |
DestinationDisplayName | Destination Display Name | string | None |
Response Formats
- application/json
- text/json
- application/xml
- text/xml.
application/json, text/json sample
{
"DestinationID": "43b14b4e-226a-445d-8f50-73d21fb61ac2",
"AccountID": "ce5902ab-1869-46ad-927f-bb78ff91cef8",
"Destination": "sample string 3",
"DestinationDisplayName": "sample string 4"
}
application/xml, text/xml sample
<DestinationOfAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
<AccountID>ce5902ab-1869-46ad-927f-bb78ff91cef8</AccountID>
<Destination>sample string 3</Destination>
<DestinationDisplayName>sample string 4</DestinationDisplayName>
<DestinationID>43b14b4e-226a-445d-8f50-73d21fb61ac2</DestinationID>
</DestinationOfAccount>
Examples
AmazonS3
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"AmazonS3": {
"UseS3TransferAcceleration": true,
"Region": "EU_WEST_2",
"BucketName": "tst1",
"UseImmutability": true
}
}
}
GoogleCloudPlatform
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"GoogleCloudPlatform": {
"StorageClass": 0,
"RegionalLocation": 0,
"BucketName": "tst1",
"UseImmutability": true
}
}
}
Wasabi
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"Wasabi": {
"Region": "string",
"BucketName": "tst1",
"UseImmutability": true
}
}
}
S3Compatible
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"S3Compatible": {
"BucketName": "tst1",
"UseImmutability": true
}
}
}
Azure
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"Azure": {
"BucketName": "tst1",
"UseImmutability": true
}
}
}
B2
{
"AccountID": "66db63b0-7036-4dd3-afe3-192168f77f7a",
"DisplayName": "tst1",
"DestinationSettings": {
"B2": {
"BucketName": "tst1",
"UseImmutability": true
}
}
}