HostTracker help - api REST agent operations

  1. GET /api/web/v1/agents - get array of HostTracker world monitoring points. request response examples
  2. GET /api/web/v1/agents/pools - get array of agent regions (Asia, Europe, America) (used for configuring tasks). request response examples
GET /api/web/v1/agents - get array of HostTracker world monitoring points
Request. GET /api/web/v1/agents
  • Authorization: bearer <your auth.token here> (how to get token see user operations)
  • Accept or Content-Type specifies response content format: application/json, text/xml.
Response. GET /api/web/v1/agents
  • 200 OK:
    • Accept: application/json or Content-Type: application/json [
        {
          "id":"guid - monitoring point id",
          "upFrom":"date - monitoring point starting date",
          "datacenter":
            {
              "name":"datacenter name",
              "city":"datacenter city",
              "country":"datacenter country",
              "state":"datacenter state"
            },
          "company":
            {
              "url":"company site",
              "name":"company name",
              "language":"company site language",
              "country":"company country"
            },
          "ip":"agent ip address",
          "version":"agent version",
          "lon":agent longitude, ex. -97.14667,
          "lat":agent latitude, ex. 31.549333,
          "pools":[array of pools, currently empty. reserved for future use]
        },
        {
          "id":"5625d028-7c78-482f-9d8d-2c41fbc752f1",
          "upFrom":"2013-04-17T15:02:38",
          "datacenter":
            {
              "name":"Waco ITG",
              "city":"Waco",
              "country":"US",
              "state":"TX"
            },
          "company":
            {
              "url":"http://guiahosting.com",
              "name":"GuiaHosting",
              "language":"ES",
              "country":"US"
            },
          "ip":"91.197.251.251",
          "version":"0.0.5230.0",
          "lon":-98.14667,
          "lat":33.549333,
          "pools":[]
        }
      ...
      ]
    • Accept: text/xml or Content-Type: text/xml <ArrayOfAgent>
      <Agent>
        <id>guid - monitoring point id</id>
        <upFrom>date - monitoring point starting date</upFrom>
        <datacenter>
          <name>datacenter name</name>
          <city>datacenter city</city>
          <country>datacenter country</country>
          <state>datacenter state</state>
        </datacenter>
        <company>
          <name>company name</name>
          <url>company site</url>
          <language>company language</language>
          <country>company country</country>
        </company>
        <ip>agent ip address</ip>
        <version>agent version</version>
        <lon>agent longitude</lon>
        <lat>agent latitude</lat>
        <pools />
      </Agent>
      <Agent>
        <id>9fac37cd-8cc7-4306-b84d-0dcb14b5ef68</id>
        <upFrom>2013-09-20T11:16:07</upFrom>
        <datacenter>
          <name>Waco ITG</name>
          <city>Waco</city>
          <country>US</country>
          <state>TX</state>
        </datacenter>
        <company>
          <name>GuiaHosting</name>
          <url>http://guiahosting.com</url>
          <language>ES</language>
          <country>US</country>
        </company>
        <ip>91.197.255.221</ip>
        <version>0.0.5230.0</version>
        <lon>-97.14667</lon>
        <lat>31.549333</lat>
        <pools />
      </Agent>
      </ArrayOfAgent>
  • 401 AccessDenied - authorization header is not provided
  • 401 WrongTicket - wrong token provided in header
  • 401 TicketExpired - specified ticket expired
Examples. GET /api/web/v1/agents
  • Request for agents in json format: GET https://www.host-tracker.com/api/web/v1/agents HTTP/1.1
    User-Agent: Fiddler
    Accept: application/json
    Host: www.host-tracker.com
    Authorization: bearer 3DD135...5EE510417
    Content-Length: 0
  • Request for agents in XML format: GET https://www.host-tracker.com/api/web/v1/agents HTTP/1.1
    User-Agent: Fiddler
    Accept: text/xml
    Host: www.host-tracker.com
    Authorization: bearer 3DD135...5EE510417
    Content-Length: 0
GET /api/web/v1/agents/pools - get array of agent regions (Asia, Europe, America) (used for configuring tasks)
Request. GET /api/web/v1/agents/pools
  • Authorization: bearer <your auth.token here> (how to get token see user operations)
  • Accept or Content-Type specifies response content format: application/json, text/xml.
Response. GET /api/web/v1/agents/pools
  • 200 OK:
    • Accept: application/json or Content-Type: application/json [
        {
          "id":"string - id of region",
          "desc":"readable region description",
          "hidden":false,     "childPools":["child1 pool id", "child1 pool id", ... ],
          "agents":[array of this region agents"],
        },
      ...
      ]
    • Accept: text/xml or Content-Type: text/xml <ArrayOfAgentPool>
      <AgentPool>
        <id>string - id of region</id>
        <desc>readable region description</desc>
        <hidden>False</hidden>
        <childPools>
          <string>id of child1 pool</string>
          <string>id of child2 pool</string>
          ...
        </childPools>
        <agents>
          <Agent>agent structure. See GET /api/web/v1/agents</Agent>
          <Agent>agent structure. See GET /api/web/v1/agents</Agent>
          ...
        </agents>
      </AgentPool>
      </ArrayOfAgentPool>
  • 401 AccessDenied - authorization header is not provided
  • 401 WrongTicket - wrong token provided in header
  • 401 TicketExpired - specified ticket expired
Examples. GET /api/web/v1/agents/pools
  • Request for agent pools in json format: GET https://www.host-tracker.com/api/web/v1/agents/pools HTTP/1.1
    User-Agent: Fiddler
    Content-Type: application/json
    Host: www.host-tracker.com
    Content-Length: 0
    Authorization: bearer ECFB190B3...653C1E78
  • Request for agent pools in XML format: GET https://www.host-tracker.com/api/web/v1/agents/pools HTTP/1.1
    User-Agent: Fiddler
    Content-Type: text/xml
    Host: www.host-tracker.com
    Content-Length: 0
    Authorization: bearer ECFB190B3...653C1E78

Help pages by categories