POST v1/accounts/{foreignaccountkey}/cloudconnector/vaults

Create a new cloud control vault. The vault tis used to securely store cloud service credentials. This are used by the cloud connector to proxy data from the devices to the cloud service.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
foreignaccountkey

The Api Account to use

string

Required

Body Parameters

The details of the new vault

CloudConnectorVault
NameDescriptionTypeAdditional information
Name

string

None.

Certificate

string

None.

PrivateKey

string

None.

CloudAccessKey

string

None.

CloudAccessSecretKey

string

None.

CryptoKey

string

None.

Version

integer

None.

ActorStatus

ActorStatusValues

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Certificate": "sample string 2",
  "PrivateKey": "sample string 3",
  "CloudAccessKey": "sample string 4",
  "CloudAccessSecretKey": "sample string 5",
  "CryptoKey": "sample string 6",
  "Version": 7,
  "ActorStatus": 0
}

application/xml, text/xml

Sample:
<CloudConnectorVault xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Guid>sample string 8</Guid>
  <ActorStatus>stable</ActorStatus>
  <Certificate>sample string 2</Certificate>
  <CloudAccessKey>sample string 4</CloudAccessKey>
  <CloudAccessSecretKey>sample string 5</CloudAccessSecretKey>
  <CryptoKey>sample string 6</CryptoKey>
  <Name>sample string 1</Name>
  <PrivateKey>sample string 3</PrivateKey>
  <Version>7</Version>
</CloudConnectorVault>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CloudConnectorVault'.

Response Information

Resource Description

The newly created Vault

PBPRReturnOfCloudConnectorVault
NameDescriptionTypeAdditional information
Data

CloudConnectorVault

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "Name": "sample string 1",
    "Certificate": "sample string 2",
    "PrivateKey": "sample string 3",
    "CloudAccessKey": "sample string 4",
    "CloudAccessSecretKey": "sample string 5",
    "CryptoKey": "sample string 6",
    "Version": 7,
    "ActorStatus": 0
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "%2Be%2B%2Bo%2Bv616uAs%2B3l5K64ig%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfCloudConnectorVault7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>%2Be%2B%2Bo%2Bv616uAs%2B3l5K64ig%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <Guid>sample string 8</Guid>
    <ActorStatus>stable</ActorStatus>
    <Certificate>sample string 2</Certificate>
    <CloudAccessKey>sample string 4</CloudAccessKey>
    <CloudAccessSecretKey>sample string 5</CloudAccessSecretKey>
    <CryptoKey>sample string 6</CryptoKey>
    <Name>sample string 1</Name>
    <PrivateKey>sample string 3</PrivateKey>
    <Version>7</Version>
  </Data>
</PBPRReturnOfCloudConnectorVault7NMnQmOk>