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 resources | GET | |
/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 aggregators | GET, POST | GET returns a list of aggregators. POST creates a new aggregator. |
/api/v3/aggregators/X/ |
Aggregator with ID=X | GET, PUT, PATCH, DELETE | |
/api/v3/aggregators/X/bonds/ |
Bonds with aggregator X as their primary agg | GET | |
/api/v3/aggregators/X/bonds_secondary/ |
Bonds with aggregator X as their secondary agg | GET | |
/api/v3/aggregators/X/bonds_current/ |
Bonds currently assigned to aggregator X | GET | |
/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 Service profiles | GET, POST | |
/api/v3/qos/X/ |
QoS profile with ID=X | GET, PUT, PATCH, DELETE | |
/api/v3/qos/X/bonds/ |
Bonds using QoS profile X | GET | |
/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 month’s prevented downtime for bond X | GET | Both the week and month have a start and end time, as well as duration (seconds) and count fields. |
/api/v3/bonds/X/restart/ |
Action to restart bond X | POST | |
/api/v3/bonds/X/detect_leg_mtus/ |
Action to detect path MTUs on all active-mode legs | POST | |
/api/v3/bonds/X/restore_to_primary_agg/ |
Action to restore bond to its primary aggregator. | POST | Returns HTTP 400 response if primary aggregator is still failed. |
/api/v3/bonds/X/legs/ |
List of legs on bond X | GET | Lists generic
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 path MTUs on leg Y | POST | Also available on
/dhcp_legs/,
/static_legs/,
/pppoe_legs/,
and
/mobilebroadband_legs/
resources |
/api/v3/bonds/X/legs/Y/state_history/ |
List of contiguous states over last 24 hours. | GET | Also available on
/dhcp_legs/,
/static_legs/,
/pppoe_legs/,
and
/mobilebroadband_legs/
resources |
/api/v3/bonds/X/dhcp_legs/ |
List of DHCP legs on bond X | GET, POST | Get returns a list of DHCP legs. POST creates a new DHCP leg on bond X. |
/api/v3/bonds/X/dhcp_legs/Y/ |
DHCP leg Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/dhcp_legs/Y/renew/ |
Action to renew DHCP on leg Y | POST | |
/api/v3/bonds/X/static_legs/ |
List of static legs on bond X | GET, POST | |
/api/v3/bonds/X/static_legs/Y/ |
Static leg Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/pppoe_legs/ |
List of PPPoE legs on bond X | GET, POST | |
/api/v3/bonds/X/pppoe_legs/Y/ |
PPPoE leg Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/mobilebroadband_legs/ |
List of mobile broadband legs on bond X | GET, POST | |
/api/v3/bonds/X/mobilebroadband_legs/Y/ |
Mobile broadband leg Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/connected_ips/ |
List of connected IPs on bond X | GET, POST | |
/api/v3/bonds/X/connected_ips/Y/ |
Connected IP Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/cpe_nat_ips/ |
List of CPE NAT IPs on bond X | GET, POST | |
/api/v3/bonds/X/cpe_nat_ips/Y/ |
CPE NAT IP Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/routes/ |
List of routes on bond X | GET, POST | |
/api/v3/bonds/X/routes/Y/ |
Route Y on bond X | GET, PUT, PATCH, DELETE | |
/api/v3/bonds/X/speedtests/ |
List of speed tests on bond X | GET, POST | |
/api/v3/bonds/X/speedtests/Y/ |
Speed test Y on bond X | GET | |
/api/v3/bonds/X/tuners/ |
List of bond performance tunings for bond X | GET, POST | Get returns a list of bond tunings for bond X. Post creates and starts a bond tuning for bond X. |
/api/v3/bonds/X/tuners/Z/ |
Bond performance tuning Z for bond X | GET | |
/api/v3/bonds/X/tuners/Z/cancel/ |
Cancel bond tuning Z | POST | Can only be done if bond tuning Z has not yet finished. |
/api/v3/bonds/X/tuners/Z/accept/ |
Accept bond tuning Z recommendations | POST | Can only be done 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 tuning Z recommendations | POST | Can only be done if bond tuning Z 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 performance tunings for leg Y on bond X | GET, POST | Get returns a list of leg tunings for leg Y 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 tuning Z for leg Y on bond X | GET | |
/api/v3/bonds/X/legs/Y/tuners/Z/cancel/ |
Cancel leg tuning Z | POST | Can only be done if leg tuning Z has not yet finished. |
/api/v3/bonds/X/legs/Y/tuners/Z/accept/ |
Accept leg tuning Z recommendations | POST | Can only be done 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 Z recommendations | POST | Can only be done 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 Allocations | GET, POST | |
/api/v3/ipallocations/X/ |
IP Allocation X | GET, PUT, PATCH, DELETE | |
/api/v3/ipallocations/X/assigned_routing_groups/ |
List of Routing Groups assigned to IP Allocation X | GET, POST | To assign an IP allocation to a routing group, POST an object containing the “routing_group” URL field. |
/api/v3/ipallocations/X/assigned_routing_groups/Y/ |
Routing Group Y currently assigned to IP Allocation X | GET, DELETE | To remove an IP allocation from a routing group, submit a DELETE request to this endpoint. |
/api/v3/mobileproviderprofiles/ |
List of mobile broadband provider profiles | GET, POST | |
/api/v3/mobileproviderprofiles/X/ |
Mobile provider profile with ID=X | GET, PUT, PATCH, DELETE | Profiles can only be deleted if leg_count = 0. |
/api/v3/users/ |
List of system users | GET, POST | |
/api/v3/users/X/ |
User X | GET, PUT, PATCH, DELETE | |
/api/v3/groups/ |
List of authentication groups | GET, POST | |
/api/v3/groups/X/ |
Group X | GET, PUT, PATCH, DELETE | |
/api/v3/permissions/ |
Mapping of permission codes to printable names | GET | |
/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 resources | GET | |
/api/v3/spaces/X/statistics/users/ |
User object statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 object statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 statistics | GET | The local
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 Allocations | GET, POST | IP 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 IP Allocations | GET, POST | IP allocations owned by a parent space. |
/api/v3/spaces/X/delegated_ip_allocations/X/ |
IP Allocation X |
|
|
/api/v3/system/ |
List of system resources | GET | |
/api/v3/system/status/ |
List of system status resources | GET | |
/api/v3/system/status/configupdates/ |
Configuration updates by status | GET | The count field is 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 month’s prevented downtime across all bonds | GET | Both the week and month have a start and end time, as well as duration (seconds) and count fields. |
/api/v3/system/status/bondingversion/ |
The version of the bonding package currently available in the software repository | GET | |
/api/v3/system/status/repositories/ |
The list of available versions in the software repository | GET | |
/api/v3/system/status/tlsinfo/ |
Certificate and CSR details for the web server TLS certificates | GET | |
/api/v3/system/status/aggfailover/ |
Aggregator failover check success and failure counts | GET | |
/api/v3/system/status/backups/ |
List of system backups | GET | |
/api/v3/system/status/backups/latest-backup/ |
Download latest backup as a zip file | GET | |
/api/v3/system/tasks/ |
List of system tasks. | GET | POST to child 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 the provisioning ISOs | POST | |
/api/v3/system/versions/ |
Software versions | GET | |
/api/v3/system/timezones/ |
List of available time zones. | GET | |
/api/v3/system/mobilebroadbandproviderapns/ |
List of mobile provider APNs, usernames, and passwords. | GET | |
/api/v3/system/isos/ |
List of ISO provisioning files | GET | ISO files are used to provision nodes |
/api/v3/settings/ |
List of system settings and values | GET, PUT, PATCH | |
/api/v3/self/ |
Branding and various UI-related settings. | GET | This is considered a private API for the use of the SD-WAN web application. It is not subject to our normal deprecation rules. Please don’t use it. |