=========
Agent API
=========

The Agent API is the API provided by the Server that the Agent uses to download its Longship, its Hammars and to upload its results.

API Endpoints
-------------

Longship
********

* GET /api/v1/longship/<hostname>

Send
^^^^

* Hostname in the path

Return
^^^^^^

.. code-block:: json

    {
        "hammars": [
            "<hammarname>",
            "<hammarname>",
            ...
        ],
        "gobalrigging": {
            "<riggingname>": <riggingvalue>,
            ...
        },
        "localrigging": {
            "<riggingname>": <riggingvalue>,
            ...
        },
        "strikes": [
            "<strikename>": {
                "<riggingname>": <riggingvalue>,
                ...
            }
        ]
    }

* variablevalue can be any valid JSON type

Hammar
******

* GET /api/v1/hammar/<hammarname>
* GET /api/v1/hammar/<hammarname>/<version>

Send
^^^^

* Hostname in path
* Version in path (optional)

Return
^^^^^^

* Hammar as a gzipped tar file

Chronicle
******

* POST /api/v1/chronicle/<hostname>

Send
^^^^

* Hostname in path
* Report in body

.. code-block:: json

    {
        "date": "<datetime>",
        "hammars": [
            "<hammarname>",
            ...
        ],
        "strikes": [
            "<strikename>": {
                "starttime": "<datetime>",
                "endtime": "<datetime>",
                "log": [
                    "<logline>",
                    ...
                ]
            },
            ...
        ]
    }

Return
^^^^^^

.. code-block:: json

    {
        status: 'ok|rejected'
    }