====
API
====

The SD-WAN Application Programming Interface (API) allows
integration with external systems for management of objects in the
SD-WAN system. It is accessed over HTTP using a pattern known
as REpresentational State Transfer, or REST.

.. toctree::
    :glob:
    :maxdepth: 2

    *
    */index

What's this for?
-----------------

Here are a few examples of what you can do with the API:

-  Integrate with your existing network monitoring system, so that your
   NOC is notified when legs or bonds go down or come back up
-  Add space and user objects automatically when records are added to
   your CRM system
-  Let your billing system automatically report legs and IP addresses on
   customer invoices
-  Connect with an existing customer portal to let customers change
   compression, QoS, or encryption settings
-  Write a one-time-use script to create bond and leg records from the
   data in an existing database
-  Create custom troubleshooting tools that report traffic loads, link
   latency, and packet loss rates in any format you need
-  Avoid IP conflicts by integrating the IP management features in this
   application with your existing IP management software

Browsing the API
-----------------

The API offers a browser-friendy interface that makes exploration and
troubleshooting very easy. To view this API, first log in to the normal
web interface using your regular username and password. Then visit the
base URI of the current API in your browser. For example, if your
management server hostname is bondingadmin.example.com, and the base URI
of the current API version is /api/v4/, point your browser to
`https://bondingadmin.example.com/api/v4/ <https://bondingadmin.example.com/api/v4/>`__.

Certain pages on the management server offer links to equivalent API
pages. On these pages, the link is found at the far bottom-right corner
of the page.
