.. _arbitrator-API-resources-overview:

Resources Overview
-------------------

.. _22.2|EKB-13697:
.. _25.1|EKB-23447:

The Arbitrator API is broken up into the resources below.
Each resource represents an object in the  Arbitrator system.
A resource will have associated data and a set of methods in
which the user may  operate on it.

.. tabularcolumns:: |p{2.5cm}|p{12.5cm}|

+---------------+---------------------------------------------------------------------------------+
| Resource      |   Description                                                                   |
+===============+=================================================================================+
| ``/ciscocdr`` | This resource will return data associated with Cisco CDR and CMR files.         |
|               | The API will  return a running total of various statistics associated           |
|               | with Cisco's call records.                                                      |
|               |                                                                                 |
|               | .. note::                                                                       |
|               |                                                                                 |
|               |    As of release 22.2, only one optional parameter: ``cm_ip`` (Call Manager IP) |
|               |    is supported.                                                                |
+---------------+---------------------------------------------------------------------------------+
| ``/system``   | This resource will return data about the Arbitrator system in general.          |
|               |                                                                                 |
+---------------+---------------------------------------------------------------------------------+

HTTP Post to Arbitrator
...........................

The Arbitrator system API also provides a route that allows for messages to be posted to it
using HTTP POST to the resource ``/syslog``.

This makes it possible for alarms outside the Arbitrator system to be enabled.

The ``curl`` syntax for this action is as follows:

::

   curl  --insecure -X POST https://<arbitrator-host>/api/syslog -d "test"

       
The message can then be seen as an event:

.. image:: /src/images/arbitrator-api-syslog-post.png