DELETE v1/accounts/{foreignaccountkey}/networks/{foreignkey}/agents/{agentid}
Delete the Agent
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
foreignaccountkey |
The Api Account the Agent is on |
string |
Required |
foreignkey |
The network on the account the Agent is on |
string |
Required |
agentid |
The unique Id that was returned during Agent creation |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The deleted Agent if found, otherwise a failure result with a 404 error code
PBPRReturnOfAgentName | Description | Type | Additional information |
---|---|---|---|
Data | Agent |
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
{ "Success": true, "Meta": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Code": 2, "ErrorCode": 3, "Data": { "AgentName": "sample string 1", "NetworkStatus": 0, "Enabled": true, "AgentTunnel": "sample string 3", "WANAdapter": "sample string 4", "Routes": "sample string 5", "Info": "sample string 6", "Services": "sample string 7", "CertCname": "sample string 8", "InstallKey": "sample string 9", "Version": 10, "ActorStatus": 0, "Status": 0, "ContextSettings": [ { "Key": "sample string 1", "SettingType": 0, "Value": "sample string 2" }, { "Key": "sample string 1", "SettingType": 0, "Value": "sample string 2" } ] }, "ErrorSubCode": 4, "ErrorDescription": "sample string 5", "StatusUrl": "sample string 6", "ContinuationToken": "sample string 7" }
application/xml, text/xml
<PBPRReturnOfAgent7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API"> <Code>2</Code> <ContinuationToken>sample string 7</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> <ActorStatus>stable</ActorStatus> <AgentName>sample string 1</AgentName> <AgentTunnel>sample string 3</AgentTunnel> <CertCname>sample string 8</CertCname> <ContextSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/AS.Interfaces.Models"> <d3p1:Setting> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:SettingType>ipaddress</d3p1:SettingType> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Setting> <d3p1:Setting> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:SettingType>ipaddress</d3p1:SettingType> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:Setting> </ContextSettings> <Enabled>true</Enabled> <Info>sample string 6</Info> <InstallKey>sample string 9</InstallKey> <NetworkStatus>disconnected</NetworkStatus> <Routes>sample string 5</Routes> <Services>sample string 7</Services> <Status>pending</Status> <Version>10</Version> <WANAdapter>sample string 4</WANAdapter> </Data> </PBPRReturnOfAgent7NMnQmOk>