Products: Managed Backup (Agent)
Article ID: m0648Last Modified: 13-Nov-2024

POST API/Accounts

Adds new account.

Request Information

URI Parameters

None.

Body Parameters

Name Description Type Additional Information
DisplayName Account Displayed Name string Required
Type Account Type AccountType Required
AccountSettings* Specific Storage Settings Settings Required

Regardless the AccountSettings structure can contain several JSON objects, the data for account creation is used from one object. The rules will be applied in the following order:

  • All objects with keys that do not align with with the Type code (provided next to DisplayName) are bypassed
  • Objects with insufficient data are bypassed
  • The data from the last item is used to create an account.

It is recommended to send only one object inside AccountSettings per one request.

Request Formats

application/json, text/json

{
  "DisplayName": "sample string 1",
  "Type": 0,
  "AccountSettings": {
    "GoogleCloudPlatform": {
      "ServiceAccountEmail": "sample string 1",
      "BinaryKeyAsBase64": "sample string 2",
      "ProjectID": "sample string 3"
    },
    "AmazonS3": {
      "AccessKey": "sample string 1",
      "SecretKey": "sample string 2",
      "IsGovCloud": true
    },
    "Azure": {
      "AccountName": "sample string 1",
      "SharedKey": "sample string 2"
    },
    "OpenStack": {
      "IgnoreCertificate": true,
      "NotCheckCredentials": true,
      "UserName": "sample string 3",
      "ApiKey": "sample string 4",
      "AuthService": "sample string 5",
      "KeyStoneVersion": 0,
      "TenantType": 0,
      "Tenant": "sample string 6",
      "UseInternalURLs": true,
      "DomainType": 0,
      "Domain": "sample string 8",
      "UseScope": true,
      "ProjectType": 0,
      "Project": "sample string 10"
    },
    "Oracle": {
      "UserName": "sample string 1",
      "ApiKey": "sample string 2",
      "AuthService": "sample string 3",
      "KeyStoneVersion": 0,
      "TenantType": 0,
      "Tenant": "sample string 4",
      "UseInternalURLs": true,
      "DomainType": 0,
      "Domain": "sample string 6",
      "UseScope": true,
      "ProjectType": 0,
      "Project": "sample string 8"
    },
    "S3Compatible": {
      "UseNativeMultipartUpload": true,
      "HTTPEnpoint": "sample string 2",
      "HTTPSEndpoint": "sample string 3",
      "IgnoreCertificate": true,
      "NotCheckCredentials": true,
      "SignatureVersion": 2,
      "AccessKey": "sample string 6",
      "SecretKey": "sample string 7",
      "IsGovCloud": true
    },
    "Cloudian": {
      "UseNativeMultipartUpload": true,
      "HTTPEnpoint": "sample string 2",
      "HTTPSEndpoint": "sample string 3",
      "IgnoreCertificate": true,
      "NotCheckCredentials": true,
      "SignatureVersion": 2,
      "AccessKey": "sample string 6",
      "SecretKey": "sample string 7",
      "IsGovCloud": true
    },
    "FS": {
      "Login": "sample string 1",
      "Pass": "sample string 2",
      "Path": "sample string 3"
    },
    "Wasabi": {
      "AccessKey": "sample string 1",
      "SecretKey": "sample string 2"
    },
    "Minio": {
      "AccessKey": "sample string 1",
      "SecretKey": "sample string 2",
      "HTTPEnpoint": "sample string 3",
      "HTTPSEndpoint": "sample string 4",
      "IgnoreCertificate": true,
      "NotCheckCredentials": true
    }
  }
}

application/xml, text/xml

<Account xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MBSAPImvc.Engine.Models">
  <AccountSettings>
    <AmazonS3>
      <AccessKey>sample string 1</AccessKey>
      <IsGovCloud>true</IsGovCloud>
      <SecretKey>sample string 2</SecretKey>
    </AmazonS3>
    <Azure>
      <AccountName>sample string 1</AccountName>
      <SharedKey>sample string 2</SharedKey>
    </Azure>
    <Cloudian>
      <AccessKey>sample string 6</AccessKey>
      <IsGovCloud>true</IsGovCloud>
      <SecretKey>sample string 7</SecretKey>
      <HTTPEnpoint>sample string 2</HTTPEnpoint>
      <HTTPSEndpoint>sample string 3</HTTPSEndpoint>
      <IgnoreCertificate>true</IgnoreCertificate>
      <NotCheckCredentials>true</NotCheckCredentials>
      <SignatureVersion>Version2</SignatureVersion>
      <UseNativeMultipartUpload>true</UseNativeMultipartUpload>
    </Cloudian>
    <FS>
      <Login>sample string 1</Login>
      <Pass>sample string 2</Pass>
      <Path>sample string 3</Path>
    </FS>
    <GoogleCloudPlatform>
      <BinaryKeyAsBase64>sample string 2</BinaryKeyAsBase64>
      <ProjectID>sample string 3</ProjectID>
      <ServiceAccountEmail>sample string 1</ServiceAccountEmail>
    </GoogleCloudPlatform>
    <Minio>
      <AccessKey>sample string 1</AccessKey>
      <HTTPEnpoint>sample string 3</HTTPEnpoint>
      <HTTPSEndpoint>sample string 4</HTTPSEndpoint>
      <IgnoreCertificate>true</IgnoreCertificate>
      <NotCheckCredentials>true</NotCheckCredentials>
      <SecretKey>sample string 2</SecretKey>
    </Minio>
    <OpenStack>
      <ApiKey>sample string 4</ApiKey>
      <AuthService>sample string 5</AuthService>
      <Domain>sample string 8</Domain>
      <DomainType>Name</DomainType>
      <KeyStoneVersion>DoNotUse</KeyStoneVersion>
      <Project>sample string 10</Project>
      <ProjectType>Name</ProjectType>
      <Tenant>sample string 6</Tenant>
      <TenantType>Name</TenantType>
      <UseInternalURLs>true</UseInternalURLs>
      <UseScope>true</UseScope>
      <UserName>sample string 3</UserName>
      <IgnoreCertificate>true</IgnoreCertificate>
      <NotCheckCredentials>true</NotCheckCredentials>
    </OpenStack>
    <Oracle>
      <ApiKey>sample string 2</ApiKey>
      <AuthService>sample string 3</AuthService>
      <Domain>sample string 6</Domain>
      <DomainType>Name</DomainType>
      <KeyStoneVersion>DoNotUse</KeyStoneVersion>
      <Project>sample string 8</Project>
      <ProjectType>Name</ProjectType>
      <Tenant>sample string 4</Tenant>
      <TenantType>Name</TenantType>
      <UseInternalURLs>true</UseInternalURLs>
      <UseScope>true</UseScope>
      <UserName>sample string 1</UserName>
    </Oracle>
    <S3Compatible>
      <AccessKey>sample string 6</AccessKey>
      <IsGovCloud>true</IsGovCloud>
      <SecretKey>sample string 7</SecretKey>
      <HTTPEnpoint>sample string 2</HTTPEnpoint>
      <HTTPSEndpoint>sample string 3</HTTPSEndpoint>
      <IgnoreCertificate>true</IgnoreCertificate>
      <NotCheckCredentials>true</NotCheckCredentials>
      <SignatureVersion>Version2</SignatureVersion>
      <UseNativeMultipartUpload>true</UseNativeMultipartUpload>
    </S3Compatible>
    <Wasabi>
      <AccessKey>sample string 1</AccessKey>
      <SecretKey>sample string 2</SecretKey>
    </Wasabi>
  </AccountSettings>
  <DisplayName>sample string 1</DisplayName>
  <Type>0</Type>
</Account>

Response Information

Resource Description

Name Description Type Additional Information
Version - Version None
Content - HttpContent None
StatusCode - HttpStatusCode None
ReasonPhrase - string None
Headers - Collection of Object None
RequestMessage - HttpRequestMessage None
IsSuccessStatusCode - boolean None
https://git.cloudberrylab.com/egor.m/doc-help-mbs.git