Agent.GetList

  • Updated on Aug 27, 2024
  • Published on May 25, 2021
  • 1 minute(s) read
  • vL
 Prev Next

Description

Returns a list of your agents with their ID, Name, Settings, Description, Geolocation, ProxyPool, CollectionID, and other important information.

URL parameters

Name Required Type Description
IncludeStartingURL False boolean Whether the response should include the staring URL of the agent. Default is False.

Responses

Name Type Description
Result string Success if the operation was successful.
Agent Agent Information on all agents in the account.

Sample request

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

Sample responses

XML

<AgentGetListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<script id="eppiocemhmnlbhjplcgkofciiegomcon"/>
<script/>
<script/>
<Result>Success</Result>
<AgentList>
<Agent>
<Created>2018-11-19 06:14:50</Created>
<Modified>2024-04-16 09:08:00</Modified>
<AgentID>1001</AgentID>
<Name>Mozenda-01</Name>
<Description/>
<Settings>BrowserIsolation, ConvertedIEAgent, MaximizeBrowserWindow, SingleBrowser, UseAnonymizer</Settings>
<Status>Ready</Status>
<Geolocation>NorthAmerica</Geolocation>
<ProxyPool/>
<CollectionID>1002</CollectionID>
</Agent>
<Agent>
<Created>2018-11-20 06:37:07</Created>
<Modified>2021-03-31 12:10:45</Modified>
<AgentID>1002</AgentID>
<Name>Mozenda-02</Name>
<Description/>
<Settings>BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, UseAnonymizer, ConvertedIEAgent</Settings>
<Status>Ready</Status>
<Geolocation>NorthAmerica</Geolocation>
<ProxyPool/>
<CollectionID>1003</CollectionID>
</Agent>
<Agent>
<Created>2018-11-26 00:21:32</Created>
<Modified>2021-03-31 12:10:45</Modified>
<AgentID>1007</AgentID>
<Name>Mozenda-03</Name>
<Description/>
<Settings>BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, ConvertedIEAgent</Settings>
<Status>Ready</Status>
<Geolocation/>
<ProxyPool/>
<CollectionID>1008</CollectionID>
</Agent>
</AgentList>
</AgentGetListResponse>

JSON (add &ResponseFormat=JSON)

{
  "Agent": [
    {
      "Created": "2018-11-19 06:14:50",
      "Modified": "2024-04-16 09:08:00",
      "AgentID": 1001,
      "Name": "Mozenda-01",
      "Description": "",
      "Settings": "BrowserIsolation, ConvertedIEAgent, MaximizeBrowserWindow, SingleBrowser, UseAnonymizer",
      "Status": "Ready",
      "Geolocation": "NorthAmerica",
      "ProxyPool": "",
      "CollectionID": "1002"
    },
    {
      "Created": "2018-11-20 06:37:07",
      "Modified": "2021-03-31 12:10:45",
      "AgentID": 1002,
      "Name": "Mozenda-02",
      "Description": "",
      "Settings": "BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, UseAnonymizer, ConvertedIEAgent",
      "Status": "Ready",
      "Geolocation": "NorthAmerica",
      "ProxyPool": "",
      "CollectionID": "1003"
    },
    {
      "Created": "2018-11-26 00:21:32",
      "Modified": "2021-03-31 12:10:45",
      "AgentID": 1007,
      "Name": "Mozenda-03",
      "Description": "",
      "Settings": "BrowserIsolation, MaximizeBrowserWindow, SingleBrowser, ConvertedIEAgent",
      "Status": "Ready",
      "Geolocation": "",
      "ProxyPool": "",
      "CollectionID": "1008"
    }
}