===
v3
===

| Introduced: 2015.4
| Status: Previous version
| Base URI: ``/api/v3/``


URIs
-----

The following resources are available. In addition to the listed
methods, each URI also supports the OPTIONS method.

======================================================== ==================== ==================== ====================
 URI                                                      Resource             Methods              Notes
======================================================== ==================== ==================== ====================
 ``/api/v3/``                                             List of core         GET
                                                          resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/nodes/``                                       List of nodes        GET                  Nodes represent
                                                                                                    the common
                                                                                                    properties between
                                                                                                    bonders and
                                                                                                    aggregators.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/nodes/X/``                                     Node with ID=X       GET                  Nodes cannot be
                                                                                                    created directly,
                                                                                                    so POST is not
                                                                                                    supported. Nodes
                                                                                                    are created by
                                                                                                    creating bonders
                                                                                                    or aggregators.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/aggregators/``                                 List of              GET, POST            GET returns a list
                                                          aggregators                               of aggregators.
                                                                                                    POST creates a new
                                                                                                    aggregator.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/aggregators/X/``                               Aggregator with      GET, PUT, PATCH,
                                                          ID=X                 DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/aggregators/X/bonds/``                         Bonds with           GET
                                                          aggregator X as
                                                          their primary agg
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/aggregators/X/bonds_secondary/``               Bonds with           GET
                                                          aggregator X as
                                                          their secondary
                                                          agg
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/aggregators/X/bonds_current/``                 Bonds currently      GET
                                                          assigned to
                                                          aggregator X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonders/``                                     List of bonders      GET                  Bonders cannot be
                                                                                                    created through
                                                                                                    the API. A bonder
                                                                                                    is created
                                                                                                    automatically when
                                                                                                    a bond is created.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonders/X/``                                   Bonder with ID=X     GET, PUT, PATCH      Bonders cannot be
                                                                                                    deleted through
                                                                                                    the API. A bonder
                                                                                                    is deleted
                                                                                                    automatically when
                                                                                                    its bond is
                                                                                                    deleted.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/qos/``                                         List of Quality of   GET, POST
                                                          Service profiles
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/qos/X/``                                       QoS profile with     GET, PUT, PATCH,
                                                          ID=X                 DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/qos/X/bonds/``                                 Bonds using QoS      GET
                                                          profile X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/``                                       List of bonds        GET, POST
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/``                                     Bond with ID=X       GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/downtime_prevented/``                  Previous week and    GET                  Both the week and
                                                          month's prevented                         month have a start
                                                          downtime for bond                         and end time, as
                                                          X                                         well as duration
                                                                                                    (seconds) and
                                                                                                    count fields.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/restart/``                             Action to restart    POST
                                                          bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/detect_leg_mtus/``                     Action to detect     POST
                                                          path MTUs on all
                                                          active-mode legs
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/restore_to_primary_agg/``              Action to restore    POST                 Returns HTTP 400
                                                          bond to its                               response if
                                                          primary                                   primary aggregator
                                                          aggregator.                               is still failed.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/``                                List of legs on      GET                  Lists generic
                                                          bond X                                    legs—object types
                                                                                                    identified by
                                                                                                    ``type`` fields.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/``                              Leg Y on bond X      GET                  Generic leg
                                                                                                    resource—object
                                                                                                    type identified by
                                                                                                    ``type`` field.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/detect_mtus/``                  Action to detect     POST                 Also available on
                                                          path MTUs on leg Y                        ``/dhcp_legs/``,
                                                                                                    ``/static_legs/``,
                                                                                                    ``/pppoe_legs/``,
                                                                                                    and
                                                                                                    ``/mobilebroadband_legs/``
                                                                                                    resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/state_history/``                List of contiguous   GET                  Also available on
                                                          states over last                          ``/dhcp_legs/``,
                                                          24 hours.                                 ``/static_legs/``,
                                                                                                    ``/pppoe_legs/``,
                                                                                                    and
                                                                                                    ``/mobilebroadband_legs/``
                                                                                                    resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/dhcp_legs/``                           List of DHCP legs    GET, POST            Get returns a list
                                                          on bond X                                 of DHCP legs. POST
                                                                                                    creates a new DHCP
                                                                                                    leg on bond X.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/dhcp_legs/Y/``                         DHCP leg Y on bond   GET, PUT, PATCH,
                                                          X                    DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/dhcp_legs/Y/renew/``                   Action to renew      POST
                                                          DHCP on leg Y
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/static_legs/``                         List of static       GET, POST
                                                          legs on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/static_legs/Y/``                       Static leg Y on      GET, PUT, PATCH,
                                                          bond X               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/pppoe_legs/``                          List of PPPoE legs   GET, POST
                                                          on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/pppoe_legs/Y/``                        PPPoE leg Y on       GET, PUT, PATCH,
                                                          bond X               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/mobilebroadband_legs/``                List of mobile       GET, POST
                                                          broadband legs on
                                                          bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/mobilebroadband_legs/Y/``              Mobile broadband     GET, PUT, PATCH,
                                                          leg Y on bond X      DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/connected_ips/``                       List of connected    GET, POST
                                                          IPs on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/connected_ips/Y/``                     Connected IP Y on    GET, PUT, PATCH,
                                                          bond X               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/cpe_nat_ips/``                         List of CPE NAT      GET, POST
                                                          IPs on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/cpe_nat_ips/Y/``                       CPE NAT IP Y on      GET, PUT, PATCH,
                                                          bond X               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/routes/``                              List of routes on    GET, POST
                                                          bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/routes/Y/``                            Route Y on bond X    GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/speedtests/``                          List of speed        GET, POST
                                                          tests on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/speedtests/Y/``                        Speed test Y on      GET
                                                          bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/tuners/``                              List of bond         GET, POST            Get returns a list
                                                          performance                               of bond tunings
                                                          tunings for bond X                        for bond X. Post
                                                                                                    creates and starts
                                                                                                    a bond tuning for
                                                                                                    bond X.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/tuners/Z/``                            Bond performance     GET
                                                          tuning Z for bond
                                                          X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/tuners/Z/cancel/``                     Cancel bond tuning   POST                 Can only be done
                                                          Z                                         if bond tuning Z
                                                                                                    has not yet
                                                                                                    finished.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/tuners/Z/accept/``                     Accept bond tuning   POST                 Can only be done
                                                          Z recommendations                         if bond tuning Z
                                                                                                    has finished
                                                                                                    successfully with
                                                                                                    recommendations,
                                                                                                    and the
                                                                                                    recommendations
                                                                                                    haven't yet been
                                                                                                    accepted or
                                                                                                    declined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/tuners/Z/decline/``                    Decline bond         POST                 Can only be done
                                                          tuning Z                                  if bond tuning Z
                                                          recommendations                           has finished
                                                                                                    successfully with
                                                                                                    recommendations,
                                                                                                    and the
                                                                                                    recommendations
                                                                                                    haven't yet been
                                                                                                    accepted or
                                                                                                    declined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/tuners/``                       List of leg          GET, POST            Get returns a list
                                                          performance                               of leg tunings for
                                                          tunings for leg Y                         leg Y on bond X.
                                                          on bond X                                 Post creates and
                                                                                                    starts a leg
                                                                                                    tuning for leg Y
                                                                                                    on bond X.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/tuners/Z/``                     Leg performance      GET
                                                          tuning Z for leg Y
                                                          on bond X
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/tuners/Z/cancel/``              Cancel leg tuning    POST                 Can only be done
                                                          Z                                         if leg tuning Z
                                                                                                    has not yet
                                                                                                    finished.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/tuners/Z/accept/``              Accept leg tuning    POST                 Can only be done
                                                          Z recommendations                         if leg tuning Z
                                                                                                    has finished
                                                                                                    successfully with
                                                                                                    recommendations,
                                                                                                    and the
                                                                                                    recommendations
                                                                                                    haven't yet been
                                                                                                    accepted or
                                                                                                    declined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/bonds/X/legs/Y/tuners/Z/decline/``             Decline leg tuning   POST                 Can only be done
                                                          Z recommendations                         if leg tuning Z
                                                                                                    has finished
                                                                                                    successfully with
                                                                                                    recommendations,
                                                                                                    and the
                                                                                                    recommendations
                                                                                                    haven't yet been
                                                                                                    accepted or
                                                                                                    declined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/ipallocations/``                               List of IP           GET, POST
                                                          Allocations
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/ipallocations/X/``                             IP Allocation X      GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/ipallocations/X/assigned_routing_groups/``     List of Routing      GET, POST            To assign an IP
                                                          Groups assigned to                        allocation to a
                                                          IP Allocation X                           routing group,
                                                                                                    POST an object
                                                                                                    containing the
                                                                                                    "routing_group"
                                                                                                    URL field.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/ipallocations/X/assigned_routing_groups/Y/``   Routing Group Y      GET, DELETE          To remove an IP
                                                          currently assigned                        allocation from a
                                                          to IP Allocation X                        routing group,
                                                                                                    submit a DELETE
                                                                                                    request to this
                                                                                                    endpoint.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/mobileproviderprofiles/``                      List of mobile       GET, POST
                                                          broadband provider
                                                          profiles
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/mobileproviderprofiles/X/``                    Mobile provider      GET, PUT, PATCH,     Profiles can only
                                                          profile with ID=X    DELETE               be deleted if
                                                                                                    leg_count = 0.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/users/``                                       List of system       GET, POST
                                                          users
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/users/X/``                                     User X               GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/groups/``                                      List of              GET, POST
                                                          authentication
                                                          groups
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/groups/X/``                                    Group X              GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/permissions/``                                 Mapping of           GET
                                                          permission codes
                                                          to printable names
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/``                                      List of spaces       GET, POST
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/``                                    Space X              GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/``                         List of statistics   GET
                                                          resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/users/``                   User object          GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    ``count`` field is
                                                                                                    the total number
                                                                                                    of user records
                                                                                                    whose home space
                                                                                                    matches the given
                                                                                                    space. The active
                                                                                                    field is the
                                                                                                    number of users
                                                                                                    with the active
                                                                                                    bit set.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/bonds/``                   Bond object          GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/qos_profiles/``            QoS profile object   GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/speed_tests/``             Speed test object    GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    ``count`` field is
                                                                                                    the total number
                                                                                                    of speed tests.
                                                                                                    The ``leg`` and
                                                                                                    ``bond`` fields
                                                                                                    list the number of
                                                                                                    those respective
                                                                                                    type of tests.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/aggregators/``             Aggregator object    GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    ``count`` field is
                                                                                                    the total number
                                                                                                    of aggregator
                                                                                                    records. The
                                                                                                    ``recent`` field
                                                                                                    is the number of
                                                                                                    aggregators that
                                                                                                    have connected to
                                                                                                    the management
                                                                                                    server in the last
                                                                                                    seven days.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/connected_ips/``           Connected IP         GET                  The ``local``
                                                          object statistics                         field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    ``count`` field is
                                                                                                    the total number
                                                                                                    of connected IP
                                                                                                    records. The
                                                                                                    ``enabled`` field
                                                                                                    is the number of
                                                                                                    connected IPs with
                                                                                                    the enabled bit
                                                                                                    set.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/routes/``                  Route object         GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/cpe_nat_ips/``             CPE NAT IP object    GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/legs/``                    Leg object           GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    ``count`` field is
                                                                                                    the total number
                                                                                                    of leg records.
                                                                                                    The ``dhcp``,
                                                                                                    ``static``, and
                                                                                                    ``pppoe`` fields
                                                                                                    list the number of
                                                                                                    those respective
                                                                                                    type of legs. The
                                                                                                    ``link_mode``
                                                                                                    field lists the
                                                                                                    number of legs
                                                                                                    with each of the
                                                                                                    respective link
                                                                                                    modes.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/statistics/bonders/``                 Bonder object        GET                  The ``local``
                                                          statistics                                field contains
                                                                                                    counts for the
                                                                                                    given space while
                                                                                                    the
                                                                                                    ``including_child_spaces``
                                                                                                    field contains
                                                                                                    counts for the
                                                                                                    given space, and
                                                                                                    its children
                                                                                                    combined. The
                                                                                                    count field is the
                                                                                                    total number of
                                                                                                    bonder records.
                                                                                                    The ``recent``
                                                                                                    field is the
                                                                                                    number of bonders
                                                                                                    that have
                                                                                                    connected to the
                                                                                                    management server
                                                                                                    in the last seven
                                                                                                    days.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/ip_allocations/``                     List of IP           GET, POST            IP allocations
                                                          Allocations                               owned by this space.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/ip_allocations/X/``                   IP Allocation X      GET, PUT, PATCH,
                                                                               DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/delegated_ip_allocations/``           List of Delegated    GET, POST             IP allocations
                                                          IP Allocations                             owned by a parent
                                                                                                     space.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/spaces/X/delegated_ip_allocations/X/``         IP Allocation X      GET, PUT, PATCH,
                                                                                        DELETE
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/``                                      List of system       GET
                                                          resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/``                               List of system       GET
                                                          status resources
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/configupdates/``                 Configuration        GET                  The count field is
                                                          updates by status                         the total number
                                                                                                    of configuration
                                                                                                    update records.
                                                                                                    The failures field
                                                                                                    is the sum of the
                                                                                                    failure count
                                                                                                    fields of all
                                                                                                    records. The
                                                                                                    status field lists
                                                                                                    the number of
                                                                                                    records with each
                                                                                                    of the respective
                                                                                                    status values.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/downtime_prevented/``            Previous week and    GET                  Both the week and
                                                          month's prevented                         month have a start
                                                          downtime across                           and end time, as
                                                          all bonds                                 well as duration
                                                                                                    (seconds) and
                                                                                                    count fields.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/bondingversion/``                The version of the   GET
                                                          bonding package
                                                          currently
                                                          available in the
                                                          software
                                                          repository
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/repositories/``                  The list of          GET
                                                          available versions
                                                          in the software
                                                          repository
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/tlsinfo/``                       Certificate and      GET
                                                          CSR details for
                                                          the web server TLS
                                                          certificates
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/aggfailover/``                   Aggregator           GET
                                                          failover check
                                                          success and
                                                          failure counts
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/backups/``                       List of system       GET
                                                          backups
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/status/backups/latest-backup/``         Download latest      GET
                                                          backup as a zip
                                                          file
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/tasks/``                                List of system       GET                  POST to child
                                                          tasks.                                    resources to
                                                                                                    launch a task; a
                                                                                                    response means
                                                                                                    that the task has
                                                                                                    been queued, not
                                                                                                    that it has
                                                                                                    completed.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/tasks/createisos/``                     Task to re-create    POST
                                                          the provisioning
                                                          ISOs
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/versions/``                             Software versions    GET
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/timezones/``                            List of available    GET
                                                          time zones.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/mobilebroadbandproviderapns/``          List of mobile       GET
                                                          provider APNs,
                                                          usernames, and
                                                          passwords.
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/system/isos/``                                 List of ISO          GET                  ISO files are used
                                                          provisioning files                        to provision
                                                                                                    nodes
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/settings/``                                    List of system       GET, PUT, PATCH
                                                          settings and
                                                          values
-------------------------------------------------------- -------------------- -------------------- --------------------
 ``/api/v3/self/``                                        Branding and         GET                  This is considered
                                                          various UI-related                        a private API for
                                                          settings.                                 the use of the
                                                                                                    SD-WAN
                                                                                                    web application.
                                                                                                    It is not subject
                                                                                                    to our normal
                                                                                                    deprecation rules.
                                                                                                    Please don't use
                                                                                                    it.
======================================================== ==================== ==================== ====================
