1/2/24, 17:06
Routers — Sightline REST API Documentation
Navigation
index
next |
previous |
Sightline REST API Documentation »
Sightline REST API V.9 »
Routers¶
/bgp_peering_sessions/¶
Methods: HEAD, OPTIONS, GET
Returns the BGP peering sessions in the deployment. Sightline returns the following for each BGP peering session:
attributes:
See BGP Peering Sessions Attributes for a list of attributes that this endpoint can return. This endpoint
returns a subset of the BGP session attributes that the /routers/ endpoint returns. The /routers/ endpoint returns
BGP session attributes with the prefix bgp_ or bgp2_ to specify the primary or secondary session, respectively.
id: The ID of the BGP peering session.
links: The URL of the BGP peering session.
relationships: The list of relationships for this endpoint.
type: Must be bgp_peering_session.
Example: Gets the list of all BGP peering sessions.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/bgp_peering_sessions/
Relationships:
router:
id (string): ID of the router with this BGP peering session. router is a relationship to the /routers/
endpoint.
type (string): Must be router.
Results:
{
"data": [
{
"attributes": {
"ip_address": "192.0.2.1",
"remote_as": "64496",
"session_name": "BGP-192.0.2.1",
"type": "primary"
},
"id": "router-121-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-121-primary"
},
"relationships": {
"router": {
"data": {
"id": "121",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/121"
}
}
},
"type": "bgp_peering_session"
},
{
"attributes": {
"session_name": "BGP2-NONE",
"type": "secondary"
},
"id": "router-121-secondary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-121-secondary"
},
file:///C:/Users/mcarabajal/Downloads/routers.html
1/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
},
{
}
]
}
"relationships": {
"router": {
"data": {
"id": "121",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/121"
}
}
},
"type": "bgp_peering_session"
"attributes": {
"ip_address": "192.0.2.4",
"remote_as": "64497",
"session_name": "BGP-192.0.2.4",
"type": "primary"
},
"id": "router-188-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-188-primary"
},
"relationships": {
"router": {
"data": {
"id": "188",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/188"
}
}
},
"type": "bgp_peering_session"
/bgp_peering_sessions/<string:resource_id>¶
Methods: HEAD, OPTIONS, GET
Returns the BGP peering session specified by <resource_id>. Sightline returns the following for the BGP peering
session:
attributes:
See BGP Peering Sessions Attributes for a list of attributes that this endpoint can return. This endpoint
returns a subset of the BGP session attributes that the /routers/ endpoint returns. The /routers/ endpoint returns
BGP session attributes with the prefix bgp_ or bgp2_ to specify the primary or secondary session, respectively.
id: The ID of the BGP peering session.
links: The URL of the BGP peering session.
relationships: The list of relationships for this endpoint.
type: Must be bgp_peering_session.
Example: Gets the values for BGP peering session ID router-188-primary.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/bgp_peering_sessions/router-188-primary
Relationships:
router:
id (string): ID of the router with this BGP peering session. router is a relationship to the /routers/
endpoint.
type (string): Must be router.
Results:
{
"data": [
{
"attributes": {
"ip_address": "192.0.2.4",
"remote_as": "64497",
"session_name": "BGP-192.0.2.4",
"type": "primary"
file:///C:/Users/mcarabajal/Downloads/routers.html
2/12
1/2/24, 17:06
}
]
Routers — Sightline REST API Documentation
}
},
"id": "router-188-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-188-primary"
},
"relationships": {
"router": {
"data": {
"id": "188",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/188"
}
}
},
"type": "bgp_peering_session"
/devices/<string:device_id>/bgp_peering_sessions/¶
Methods: HEAD, OPTIONS, GET
Returns the BGP peering sessions for the specified device. Sightline returns the following for each BGP peering session:
attributes: See BGP Peering Sessions Attributes for a list
id: The ID of the BGP peering session.
links: The URL of the BGP peering session.
relationships: The list of relationships for this endpoint.
type: Must be bgp_peering_session.
of attributes that this endpoint can return.
Example: Gets the BGP peering sessions for TMS device 121.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/devices/121/bgp_peering_sessions/
Relationships:
router (object):
id (string): ID of router assigned to this BGP peering session.
type (string): Must be router.
Results:
{
"data": [
{
"attributes": {
"ip_address": "192.0.20.3",
"remote_as": "64496",
"session_name": "BGP-192.0.20.3",
"type": "primary"
},
"id": "router-166-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-166-primary"
},
"relationships": {
"router": {
"data": {
"id": "166",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/166"
}
}
},
"type": "bgp_peering_session"
},
{
"attributes": {
"ip_address": "192.0.20.6",
"remote_as": "64498",
"session_name": "BGP-192.0.20.6",
"type": "primary"
file:///C:/Users/mcarabajal/Downloads/routers.html
3/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
},
"id": "router-163-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-163-primary"
},
"relationships": {
"router": {
"data": {
"id": "163",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/163"
}
}
},
"type": "bgp_peering_session"
}
}
],
"links": {
"self": "https://example.com/api/sp/devices/121/bgp_peering_sessions/"
}
/devices/<string:device_id>/bgp_peering_sessions/<string:bgp_peering_session_id>¶
Methods: HEAD, OPTIONS, GET
Returns the specified BGP peering session for the specified device, where:
<bgp_peering_session_id> = the BGP peering session
<device_id> = the device
Sightline returns the following for the BGP peering session:
attributes: See BGP Peering Sessions Attributes for a list
id: The ID of the BGP peering session.
links: The URL of the BGP peering session.
relationships: The list of relationships for this endpoint.
type: Must be bgp_peering_session.
of attributes that this endpoint can return.
Example: Gets BGP peering session router-163-primary for TMS device 121.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/devices/121/bgp_peering_sessions/router-163-primary
Relationships:
router (object):
id (string): ID of router assigned to this BGP peering session.
type (string): Must be router.
Results:
{
"data": {
"attributes": {
"ip_address": "192.0.2.12",
"remote_as": "64499",
"session_name": "BGP-192.0.2.12",
"type": "primary"
},
"id": "router-163-primary",
"links": {
"self": "https://example.com/api/sp/bgp_peering_sessions/router-163-primary"
},
"relationships": {
"router": {
"data": {
"id": "163",
"type": "router"
},
"links": {
"related": "https://example.com/api/sp/routers/163"
}
}
},
file:///C:/Users/mcarabajal/Downloads/routers.html
4/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
"type": "bgp_peering_session"
}
},
"links": {
"self": "https://example.com/api/sp/devices/121/bgp_peering_sessions/router-163-primary"
}
/routers/¶
Methods: POST, OPTIONS
Adds a router with the attributes passed in with a JSON payload.
The available attributes are:
Attribute
Description
name
description
(string) Router name
(string) Router description
tags
(array (string)) An array of tags to apply to this router.
Each tag must consist only of alphanumeric, dash,
underscore or space characters.
adaptive_flow_rate
(integer) The router’s adaptive flow rate.
adaptive_flow_snmp_scaling
(boolean) If true, allows the system to adjust the
reported traffic differences that it sees between traffic
flow information and SNMP reported traffic levels.
adaptive_flow_snmp_scaling_max
advanced_bgp_default
(integer) The maximum SNMP flow scaling factor.
(string) The router to use for the BGP shared routing
table. (not available for 8.1)
advanced_eseries_appid
(boolean) If true, Sightline detects applications in the
ArborFlow that the e100 sends.
(string) Select an algorithm to classify interfaces during
auto-configuration that either report no traffic or have no
associated BGP information: internal, external, or
use_bgp_and_local. use_bgp_and_local classifies each
observed flow, based on learned BGP information and
the configured IP address space.
(string) Specify if you want Sightline to detect traffic on
the router using only flow (flow) or both flow and
SNMP polling (all).
advanced_fallback_alg
advanced_flow_seen
advanced_handle_dynamic_interfaces
(boolean) If true, Sightline discovers and tracks only the
interfaces that match an auto-configuration rule. The
interfaces that are not discovered are placed by Sightline
into one aggregated, untracked interface.
advanced_huawei_use_raw
(boolean) If true, polling interface counters use the raw
SNMP index when the mapping table is populated, but
there is no entry for an index in the mapping table.
(integer) The default local AS number override.
advanced_local_as
advanced_local_as2
advanced_originator
advanced_output_ifmap
advanced_poll_alcatel_ifmib
advanced_reflected_may_be_external
(integer) The default local AS number for the secondary
BGP session.
(string) The Originator ID, in the form of an IPv4 host
address, that this router uses for iBGP peering.
(integer) The flow output interface override index
number.
(boolean) If true, Sightline polls both the IF-MIB and
the default MIB for interface information.
(boolean) Specify true if you use the default router
option and if you want the system to auto-classify the
interfaces on this router as external.
advanced_use_simpson_flowspec_redirect_ip
(boolean) If true, BGP Redirect-to-IP flowspec
announcements are generated conforming to draftsimpson-idr-flowspec-redirect-02.txt.
bgp_capabilities_announce_ipv4_mitigation_routes
(boolean) If true, Sightline is permitted to generate BGP
IPv4 diversion announcements over the primary BGP
peering session.
file:///C:/Users/mcarabajal/Downloads/routers.html
5/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
Attribute
Description
bgp_capabilities_announce_ipv6_mitigation_routes
(boolean) If true, Sightline is permitted to generate BGP
IPv6 diversion announcements over the primary BGP
peering session.
bgp_capabilities_as4byte
(boolean) If true, the router natively supports 4-byte AS
numbers per RFC 4893, and 4-byte AS numbers should
be used on the primary BGP peering session.
bgp_capabilities_flowspec (deprecated)
(boolean) If true, Sightline can use the primary BGP
peering session to generate BGP flowspec diversion
announcements for IPv4 traffic in flowspec mitigations
and TMS mitigations.
Note: In REST API V.3 and above, use
bgp_capabilities_flowspec_ipv4 in this endpoint
instead of this attribute.
bgp_capabilities_flowspec_ipv4
(boolean) If true, Sightline can use the primary BGP
peering session to generate BGP flowspec diversion
announcements for IPv4 traffic in flowspec mitigations
and TMS mitigations.
Note: This attribute corresponds to the Sightline UI
setting IPv4 Flow Specification for the router’s primary
BGP session.
bgp_capabilities_flowspec_ipv6
(boolean) If true, Sightline can use the primary BGP
peering session to generate BGP flowspec diversion
announcements for IPv6 traffic in flowspec mitigations
and TMS mitigations.
Note: This attribute corresponds to the Sightline UI
setting IPv6 Flow Specification for the router’s primary
BGP session.
bgp_capabilities_l3vpn_flowspec_ipv4
(boolean) (MPLS Layer 3 VPNs only) If true, Sightline
includes the route distinguisher (RD) and route target
(RT) values in BGP flowspec diversion announcements
for IPv4 traffic in flowspec mitigations and TMS
mitigations.
Important: This attribute is ignored if the
bgp_capabilities_flowspec_ipv4 attribute in this
endpoint is false.
To configure RD and RT attributes, see the following
endpoints:
devices for TMS devices
tms_groups for TMS groups
global_afsm_settings for flowspec
auto-
mitigations
mitigations
for manual flowspec mitigations
Note: This attribute corresponds to the Sightline UI
setting Flowspec VPN for the router’s primary BGP
session.
bgp_capabilities_l3vpn_flowspec_ipv6
(boolean) (MPLS Layer 3 VPNs only) If true, Sightline
includes the route distinguisher (RD) and route target
(RT) values in BGP flowspec diversion announcements
for IPv6 traffic in flowspec mitigations and TMS
mitigations.
Important: This attribute is ignored if the
bgp_capabilities_flowspec_ipv6 attribute in this
file:///C:/Users/mcarabajal/Downloads/routers.html
6/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
Attribute
Description
endpoint is false.
To configure RD and RT attributes, see the following
endpoints:
devices for TMS devices
tms_groups for TMS groups
global_afsm_settings for flowspec
auto-
mitigations
mitigations
for manual flowspec mitigations
Note: This attribute corresponds to the Sightline UI
setting Flowspec VPN for the router’s primary BGP
session.
bgp_capabilities_labeled_unicast
bgp_capabilities_monitor_routes_ipv4
bgp_capabilities_monitor_routes_ipv6
bgp_capabilities_monitor_routes_vpnv4
bgp_default_mitigations_blackhole
bgp_default_mitigations_flowspec
bgp_ip_address
bgp_md5_secret
bgp_remote_as
bgp_session_name
bgp_update_source
bgp2_capabilities_announce_ipv4_mitigation_routes
bgp2_capabilities_announce_ipv6_mitigation_routes
bgp2_capabilities_as4byte
bgp2_capabilities_labeled_unicast
bgp2_inhibit_sp_peer
bgp2_ip_address
file:///C:/Users/mcarabajal/Downloads/routers.html
(boolean) If true, Sightline is permitted to generate BGP
6PE diversion announcements for for IPv6 destinations
over the primary BGP session per RFC 4798.
(string) If primary, the primary BGP peering session is
used to monitor the IPv4 routes on the router for the
purposes of classifying IPv4 traffic. If secondary, the
secondary BGP peering session is used. If disabled, IPv4
routes are not monitored and IPv4 traffic is not classified
using BGP routing information from this router.
(string) If primary, the primary BGP peering session is
used to monitor the IPv6 routes on the router for the
purposes of classifying IPv6 traffic. If secondary, the
secondary BGP peering session is used. If disabled, IPv6
routes are not monitored and IPv6 traffic is not classified
using BGP routing information from this router.
(string) If primary, the primary BGP peering session is
used to monitor the IPv4 VPN routes on the router for
the purposes of classifying IPv4 VPN traffic. If
secondary, the secondary BGP peering session is used.
If disabled, IPv4 VPN routes are not monitored and
IPv4 VPN traffic is not classified using BGP routing
information from this router.
(string) The default router for blackhole mitigations.
(string) The default router for flowspec mitigations.
(string) The remote IP address that you want Sightline to
use to create a BGP peering session with this router.
(string) The secret that Sightline uses for BGP peering
between the Sightline appliance and the BGP routers.
(integer) The ASN of the router.
(string) A name to help identify the BGP peering session
in the Sightline UI when you create a blackhole or TMS
mitigation. The default name is Primary.
(string) The primary BGP local IP address.
(boolean) If true, use this peering session for BGP
diversion announcements with an IPv4 TMS mitigation.
(boolean) If true, use this peering session for BGP
diversion announcements with an IPv6 TMS mitigation.
(boolean) If true, the router natively supports 4-byte AS
numbers per RFC 4893, and 4-byte AS numbers should
be used on the secondary BGP peering session.
(boolean) If true, Sightline is permitted to generate BGP
6PE diversion announcements for IPv6 destinations over
the secondary BGP session per RFC 4798.
(boolean) If true, prevents Sightline appliances from
peering with this router. The router will still be used in
TMS mitigations when a TMS appliance peers with this
router.
(string) The remote IP address that you want Sightline to
use to create a secondary BGP peering session with this
7/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
Attribute
bgp2_md5_secret
bgp2_remote_as
bgp2_router_id
bgp2_session_name
bgp2_update_source
flow_alerting
flow_alerting_timeout
flow_export_ip
flow_flow_ignored
flow_flow_ignored_ipv6
flow_monitor_add
flow_monitor_default
flow_monitor_ignore
flow_monitor_set
flow_sample_rate
flow_tcp_flags
flow_use_embedded_sampling_rate
flow_use_src_port_for_v9
history
is_proxy
Description
router.
(string) The secret that Sightline uses for BGP peering
between the Sightline appliance and the BGP routers.
(integer) The ASN of the router.
(string) An IP address that will be used by Sightline in
the secondary BGP session to differentiate itself from the
primary BGP session.
(string) A name to help identify the BGP peering session
in the Sightline UI when you create a blackhole or TMS
mitigation. The default name is Secondary.
(string) The secondary BGP local IP address.
(boolean) If true, enables flow down alerting for this
router.
(integer) The flow down alerting timeout in seconds. The
default is 120.
(string) The IP address of the router that sends flow
records to Sightline.
(string) Either ignore NetFlow from this router (on) or
not (off).
(string) Either ignore IPv6 NetFlow from this router (on)
or not (off).
(string) One of the following interfaces to be monitored:
GigabitEthernet1, GigabitEthernet2, Loopback0, or
POS0/0.
(string) Monitor interfaces on this router by default
(monitor), ignore interfaces on this router by default
(ignore), or restore the original system default
monitoring state (default).
(string) One of the following interfaces to be ignored:
GigabitEthernet1, GigabitEthernet2, Loopback0, or
POS0/0.
(string) If default, restores all interfaces to their default
settings.
(integer) The sample rate of the flow information sent by
this router. The default setting is true
(boolean) If true, the system uses TCP flag information
from flows coming from this router.
(boolean) If true, Sightline looks for a flow sampling
rate that is embedded in the flow packet.
(boolean) If true, uses a source port for v9.
(string) Shows the appliances that previously managed
the router.
(boolean) If true, Sightline treats the router as a proxy
for other routers. In this case, Sightline associates flow
with routers that are behind the proxy according to the
IPv4 address found in the ExporterIPv4Address field of
the flow received from the proxy.
For more information, see “Configuring Proxies for
Routers” in the Sightline and Threat Mitigation System
Advanced Configuration Guide.
Note: A proxy does not need to be licensed. When this
attribute is set to true, the license_type attribute may be
set to unset.
license_type
snmp_authpassword
file:///C:/Users/mcarabajal/Downloads/routers.html
(string) The router license type: core, edge, or unset. For
more information, see “Configuring Routers” in the
Sightline and TMS User Guide.
(string) SNMP v3 password for snmp_username. If
snmp_security_level is set to noAuthNoPriv, do not
8/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
Attribute
Description
configure this.
snmp_authprotocol
(string) SNMP v3 authentication protocol. Use one of the
following:
md5
sha
sha-224
sha-256
sha-384
sha-512
snmp_catos_names
(string) Configures special CatOS interface name
handling
snmp_community
(string) Community password for authenticating the
SNMP information. You need the community string to
access SNMP data on the router. If you do not specify a
community string, then the system defaults to public.
(string) The SNMP context name. The context name
indicates in what context this SNMP management
information exists.
(boolean) If true, enables router CPU/memory SNMP
polling.
(string) The SNMP IP address.
(string) The SNMP local IP address.
snmp_contextname
snmp_hardware_polling
snmp_ip_address
snmp_local_ip_address
snmp_no_getbulk
snmp_no_v1_hc_counters
snmp_priv_protocol
snmp_privkey
snmp_security_level
(boolean) If true, the router does not correctly support
the SNMP GETBULK operation for efficiently
retrieving large amounts of data (SNMP versions 2c and
3 only).
(boolean) If true, the router does not support sending
high capacity interface counters using SNMP version 1.
Low capacity counters can wrap quickly on high-speed
interfaces with significant traffic. This can cause
Sightline to display incorrect data on the System Tuning
page (System > Tuning).
(string) The SNMP v3 privacy protocol: DES or AES.
DES is used if this attribute is not set.
(string) SNMP v3 privacy key.
(string) SNMP v3 security level. Use one of the
following:
noAuthNoPriv: No passphrase authentication is
performed.
authNoPriv: Passphrase authentication is
performed, but there is no encryption of the data in
the trap messages.
authPriv: Passphrase authentication is performed
and the data in the trap messages is encrypted.
snmp_username
snmp_version
(string) SNMP v3 user name.
(integer) SNMP version to use: 1, 2, or 3.
Relationships:
collector_gid (read-only):
id (string): ID of this router’s managing device. type (string): Must be device.
Example: Creates the router-chicago router.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-H "Content-Type: application/vnd.api+json" \
-d @addrouter.json \
-L https://example.com/api/sp/routers/ \
-X POST
file:///C:/Users/mcarabajal/Downloads/routers.html
9/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
The addrouter.json file contains the following:
{
}
"data": {
"attributes": {
"bgp_session_name": "BGP-203.0.113.28",
"advanced_fallback_alg": "internal",
"bgp_remote_as": "60000",
"snmp_community": "public",
"name": "router-chicago",
"bgp2_capabilities_labeled_unicast": false,
"flow_sample_rate": "100",
"bgp_capabilities_monitor_routes_ipv4": "primary",
"advanced_local_as": "60000",
"snmp_ip_address": "203.0.113.28",
"bgp_capabilities_labeled_unicast": false,
"flow_alerting": true,
"bgp_capabilities_monitor_routes_vpnv4": "primary",
"flow_export_ip": "203.0.113.28",
"license_type": "edge",
"bgp2_session_name": "BGP2-NONE",
"flow_flow_ignored_ipv6": "off",
"advanced_use_simpson_flowspec_redirect_ip": false,
"bgp_ip_address": "203.0.113.28",
"flow_flow_ignored": "off",
"tags": [
"001",
"002"
]
}
}
Methods: HEAD, OPTIONS, GET
Lists the current configured routers.
Example: Gets the list of routers.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/routers/
/routers/<int:resource_id>¶
Methods: HEAD, OPTIONS, GET
Lists the attributes and values of the <routers_id> router.
Example: Lists the attributes and their values for router 123, which is named router-chicago
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/routers/123
Results:
{
"attributes": {
"advanced_fallback_alg": "internal",
"advanced_local_as": "60000",
"advanced_use_simpson_flowspec_redirect_ip": false,
"bgp2_capabilities_labeled_unicast": false,
"bgp2_session_name": "BGP2-NONE",
"bgp_capabilities_flowspec": true,
"bgp_capabilities_flowspec_ipv4": true,
"bgp_capabilities_flowspec_ipv6": true,
"bgp_capabilities_l3vpn_flowspec_ipv4": false,
"bgp_capabilities_l3vpn_flowspec_ipv6": false,
"bgp_capabilities_labeled_unicast": false,
"bgp_capabilities_monitor_routes_ipv4": "primary",
"bgp_ip_address": "203.0.113.28",
"bgp_remote_as": "60000",
"bgp_session_name": "BGP-203.0.113.28",
"flow_alerting": true,
"flow_export_ip": "203.0.113.28",
"flow_flow_ignored": "off",
"flow_flow_ignored_ipv6": "off",
"flow_sample_rate": "100",
"is_proxy": false,
"license_type": "edge",
file:///C:/Users/mcarabajal/Downloads/routers.html
10/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
"name": "router-chicago",
"snmp_authprotocol": "md5",
"snmp_community": "public",
"snmp_ip_address": "203.0.113.28",
"snmp_security_level": "noAuthNoPriv",
"snmp_version": 2
}
},
"id": "123",
"links": {
"self": "https://example.com/api/sp/routers/123"
},
"relationships": {
"collector_gid": {
"data": {
"id": "116",
"type": "device"
},
"links": {
"related": "https://example.com/api/sp/devices/116"
}
}
},
"type": "router"
Methods: OPTIONS, DELETE
Deletes a router.
Example: Deletes router 123
$ curl \
-H "X-Arbux-APIToken: <token>" \
-L https://example.com/api/sp/routers/123 \
-X DELETE
Methods: OPTIONS, PATCH
Changes any of the attribute values of the <routers_id> router with the attributes passed in with a JSON payload.
Note: You cannot move a router to another managing device by using PATCH with the routers endpoint. You must use
the device endpoint instead.
Example: Changes the advanced_fallback_alg attribute to external for router 123.
$ curl \
-H "X-Arbux-APIToken: <token>" \
-H "Content-Type: application/vnd.api+json" \
-d @changerouter.json \
-L https://example.com/api/sp/routers/123 \
-X PATCH
The changerouter.json file contains the following:
{
}
"data": {
"attributes": {
"advanced_fallback_alg": "external"
}
}
BGP Peering Sessions Attributes¶
Attribute
ip_address
Description
remote_as
(string) The remote IP address that Sightline uses to create a BGP peering session with this
router.
(string) The secret key that Sightline uses for BGP peering between the Sightline device and
the BGP router.
(integer) The ASN of the router.
router_id
(string) The IP address that Sightline uses for the secondary BGP session.
session_name
(string) The name that identifies the BGP peering session in the Sightline UI when you create a
blackhole or TMS mitigation.
(string) If primary, this is the primary BGP peering session of its router. If secondary, this is
the secondary BGP peering session its router.
md5_secret
type
file:///C:/Users/mcarabajal/Downloads/routers.html
11/12
1/2/24, 17:06
Routers — Sightline REST API Documentation
Table Of Contents
Access and Authorization
Breaking Changes
Versioning and Deprecation
Sightline REST API V.9
API Introduction
Endpoints
Alerts
Applications
BGP Traps
Configuration Management
Devices
Fingerprints
Global Detection Settings
Global Flowspec Auto-Mitigation Settings
Global TMS Mitigation Settings
Insight
Learning Mitigations
Local
Managed Objects
Mitigations
Notification Groups
Packet Capture Analyses
Routers
/bgp_peering_sessions/
/bgp_peering_sessions/<string:resource_id>
/devices/<string:device_id>/bgp_peering_sessions/
/devices/<string:device_id>/bgp_peering_sessions/<string:bgp_peering_session_id>
/routers/
/routers/<int:resource_id>
BGP Peering Sessions Attributes
Search Results
Shared Host Detection Settings
Sightline Signaling Configuration
Sightline Signaling Mitigation Requests
Smart Alert Settings
TMS Configuration
Traffic Queries
Traffic Query Facets
Traffic Query Facet Values
User-Defined Misuse Types
Sightline REST API V.8
Sightline REST API V.7
Sightline REST API V.6
Sightline REST API V.5
Previous topic
Packet Capture Analyses
Next topic
Search Results
Navigation
index
next |
previous |
Sightline REST API Documentation »
Sightline REST API V.9 »
© Copyright 2017, Arbor Networks. Created using Sphinx 1.5.2.
file:///C:/Users/mcarabajal/Downloads/routers.html
12/12