AgentService


Click here for a complete list of operations.

GetAgents

Get available monitoring points

Params:
  • includePools - include in every agent information about pools in which they are
Result: array of Agent
Agent:
  • id - identifier of agent (GUID), can be used when create task for monitoring from this agent
  • upFrom - time of agent working
  • datacenter - agent hosting location info:
    • name - datacenter name
    • city - datacenter city
    • country - datacenter country ISO code
    • state - datacenter state (if provided) of country
  • company - agent hosting owner info:
    • name - company name
    • url - company url
    • language - company language (site language)
    • country - company country
  • ip - agent IP address
  • version - agent version
  • lon - geographical coordinate: longitude
  • lat - geographical coordinate: latitude
  • pools - pools in which agent exists (returned only if specified flag includePools)

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/GetAgents"

<?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>
    <GetAgents xmlns="http://www.host-tracker.com/Services">
      <includePools>boolean</includePools>
    </GetAgents>
  </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>
    <GetAgentsResponse xmlns="http://www.host-tracker.com/Services">
      <GetAgentsResult>
        <Agent>
          <id>guid</id>
          <upFrom>dateTime</upFrom>
          <datacenter>
            <name>string</name>
            <city>string</city>
            <country>string</country>
            <state>string</state>
          </datacenter>
          <company>
            <name>string</name>
            <url>string</url>
            <language>string</language>
            <country>string</country>
          </company>
          <ip>string</ip>
          <version>string</version>
          <lon>double</lon>
          <lat>double</lat>
          <pools>
            <string>string</string>
            <string>string</string>
          </pools>
        </Agent>
        <Agent>
          <id>guid</id>
          <upFrom>dateTime</upFrom>
          <datacenter>
            <name>string</name>
            <city>string</city>
            <country>string</country>
            <state>string</state>
          </datacenter>
          <company>
            <name>string</name>
            <url>string</url>
            <language>string</language>
            <country>string</country>
          </company>
          <ip>string</ip>
          <version>string</version>
          <lon>double</lon>
          <lat>double</lat>
          <pools>
            <string>string</string>
            <string>string</string>
          </pools>
        </Agent>
      </GetAgentsResult>
    </GetAgentsResponse>
  </soap:Body>
</soap:Envelope>