AgentService


Click here for a complete list of operations.

GetAgentPools

Get available monitoring pools

Result: array of AgentPool
AgentPool:
  • id - identifier of agent pool, can be used when create task for monitoring from this pool
  • desc - pool description
  • mainAgentId - id of main agent in pool (if exists)
  • mainAgent - Agent info of main agent
  • fallbackAgentId - id of fallback agent in pool (if exists, used when main agent fails)
  • fallbackAgent - Agent info of fallback agent
  • agents - Agent array of all pool agents

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api/soap/v1/agent.asmx HTTP/1.1
Host: www.host-tracker.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.host-tracker.com/Services/GetAgentPools"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="http://www.host-tracker.com/Services">
      <login>string</login>
      <password>string</password>
      <ticket>string</ticket>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetAgentPools xmlns="http://www.host-tracker.com/Services" />
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAgentPoolsResponse xmlns="http://www.host-tracker.com/Services">
      <GetAgentPoolsResult>
        <AgentPool>
          <id>string</id>
          <desc>string</desc>
          <agents>
            <Agent xsi:nil="true" />
            <Agent xsi:nil="true" />
          </agents>
          <childPools>
            <string>string</string>
            <string>string</string>
          </childPools>
          <hidden>boolean</hidden>
        </AgentPool>
        <AgentPool>
          <id>string</id>
          <desc>string</desc>
          <agents>
            <Agent xsi:nil="true" />
            <Agent xsi:nil="true" />
          </agents>
          <childPools>
            <string>string</string>
            <string>string</string>
          </childPools>
          <hidden>boolean</hidden>
        </AgentPool>
      </GetAgentPoolsResult>
    </GetAgentPoolsResponse>
  </soap:Body>
</soap:Envelope>