Agent.Delete
  • 14 May 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Agent.Delete

  • Dark
    Light
  • PDF

Article Summary

Description

Deletes an agent and all associated schedules for that agent.

URL parameters

NameRequiredTypeDescription
AgentIDTruenumericUnique identifier of the agent.

Responses

NameTypeDescription
ResultstringSuccess if the operation was successful.

Sample request

curl -X GET "https://api.mozenda.com/rest?WebServiceKey=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&Service=Mozenda10&Operation=Agent.Delete&AgentID=1040"

Sample responses

XML

<?xml version="1.0" encoding="utf-8" ?>
<AgentDeleteResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Result>Success</Result>
</AgentDeleteResponse>

JSON (add &ResponseFormat=JSON)

{
  "JsonResult": {
    "Command": "Agent.Delete",
    "AutoLoggedIn": false,
    "WebConsoleKey": "",
    "Result": "Success",
    "ErrorCode": "",
    "ErrorDescription": "",
    "ErrorList": [],
    "ExecutionTime": {
      "Ticks": 0,
      "Days": 0,
      "Hours": 0,
      "Milliseconds": 0,
      "Minutes": 0,
      "Seconds": 0,
      "TotalDays": 0,
      "TotalHours": 0,
      "TotalMilliseconds": 0,
      "TotalMinutes": 0,
      "TotalSeconds": 0
    }
  }
}

Was this article helpful?

What's Next