{% include 'includes/header.html' %}

API v1.0 Documentation

You can interact with the agent using a RESTful API. This API gives you full access to the agent and its data.

Variables

When reading this documentation you will find variables in two forms:

Responses

All the responses from the agent will be in JSON format and will include three sections: For example, for the following call you will get the following response:
/api/v1.0/analytics/top_prefixes?limit_prefixes=10&start_time=2015-07-13T14:00&end_time=2015-07-14T14:00&net_masks=20,24

  {
    "meta": {
      "error": false,
      "length": 10,
      "request_time": 11.99163
    },
    "parameters": {
      "end_time": "2015-07-14T14:00",
      "exclude_net_masks": false,
      "limit_prefixes": 10,
      "net_masks": "20,24",
      "start_time": "2015-07-13T14:00"
    },
    "result": [
      {
        "as_dst": 43650,
        "key": "194.14.177.0/24",
        "sum_bytes": 650537594
      },
      ...
      {
        "as_dst": 197301,
        "key": "80.71.128.0/20",
        "sum_bytes": 5106731
      }
    ]
  }
{% for section, endpoints in documentation.iteritems() %}

{{ section }} Endpoint

{% for endpoint in endpoints %}

{{ endpoint['endpoint']}}

{% for method in endpoint['methods'] %}
{{method['method']}}
Description:
{{ method['description']|safe }}
Arguments: Returns: Examples: {% endfor %} {% endfor %} {% endfor %} {% include 'includes/footer.html' %}