PATCH v1/accounts/{foreignaccountkey}/cloudconnector/endpoints/{endpointname}

Update the cloud control Endpoint. <br/> Note that is endpoint returns a 202 code as the request is queued. A status url is returned in the return meta-data that can be used to poll the status of this request. When the Endpoint is updated successfully on the Asavie platform it's Status property will be set as 'complete'

Request Information

URI Parameters

Name	Description	Type	Additional information
foreignaccountkey	The Api Account to use	string	Required
endpointname	The name of the Endpoint to update	string	Required

Body Parameters

None.

Response Information

Resource Description

The updated created Endpoint

PBPRReturnOfCloudConnectorEndpoint

Name	Description	Type	Additional information
Data		CloudConnectorEndpoint	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",
    "Port": 2,
    "EndpointType": 3,
    "Version": 4,
    "ActorStatus": 0,
    "Host": "sample string 5",
    "Tags": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Credentials": {
      "CredentialType": 1,
      "VaultName": "sample string 2",
      "VaultPassword": "sample string 3"
    }
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "6vytsPjpxLiToP72972rmQ%3D%3D"
}

application/xml, text/xml

Sample:

<PBPRReturnOfCloudConnectorEndpoint7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>6vytsPjpxLiToP72972rmQ%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 6</Guid>
    <ActorStatus>stable</ActorStatus>
    <Credentials>
      <Guid>sample string 4</Guid>
      <CredentialType>1</CredentialType>
      <VaultName>sample string 2</VaultName>
      <VaultPassword>sample string 3</VaultPassword>
    </Credentials>
    <EndpointType>3</EndpointType>
    <Host>sample string 5</Host>
    <Name>sample string 1</Name>
    <Port>2</Port>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Tags>
    <Version>4</Version>
  </Data>
</PBPRReturnOfCloudConnectorEndpoint7NMnQmOk>