/v1/sites/{siteId}/circuits

  • Updated on Nov 4, 2026
  • Published on Jul 9, 2026
  • P
 Prev Next
Get
/v1/sites/{siteId}/circuits

Get Circuits for the site

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Path parameters
siteId
integer (int64) Required
Example1234567891011
Responses
200

OK

Expand All
object
data
Array of object (v1SitesSiteIdCircuitsGetResponseData)
object
circuits
Array of object (manaV2Circuit)
object
bgpAggregations
Array of object (manaV2BgpAggregation)
object
asSet
boolean
Exampletrue
id
integer (int64)
Example1234567891011
prefix
string
Exampleexample string
summaryOnly
boolean
Exampletrue
bgpMultipath
object (manaV2BgpMultipath)
enabled
boolean
Exampletrue
vrfId
integer (int64)
Example1234567891011
bgpNeighbors
Array of object (manaV2BgpNeighbor)
object
addressFamilies
Array of object (manaV2BgpNeighborAddressFamily)
object
addressFamily
string
ExampleENUM_VALUE
id
integer (int64)
Example1234567891011
inboundPolicy
string
Exampleexample string
outboundPolicy
string
Exampleexample string
allowAsIn
integer (int32)
Minimum0
Example123
asOverride
boolean
Exampletrue
bfd
object (manaV2BfdInstance)
enabled
boolean
Exampletrue
minimumInterval
integer (int32)
Minimum0
Example123
multiplier
integer (int32)
Minimum0
Example123
bfdNeighbor
object (manaV2BfdNeighbor)
desiredMinimumTxInterval
integer (int32)
Minimum0
Example123
ifIndex
integer (int32)
Minimum0
Example123
interface
string
Exampleexample string
lastUpdated
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
localDiag
string
ExampleENUM_VALUE
peerAddress
string
Exampleexample string
remoteDiag
string
ExampleENUM_VALUE
requiredMinimumRxInterval
integer (int32)
Minimum0
Example123
segmentName
string
Exampleexample string
sourceAddress
string
Exampleexample string
state
string
ExampleENUM_VALUE
timeInState
object (googleProtobufDuration)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
up
boolean
Exampletrue
bgpType
string
ExampleENUM_VALUE
defaultOriginate
string

Set when default route needs to be advertised in BGP domain

ExampleENUM_VALUE
dynamicNeighborPeers
Array of object (manaV2BgpDynamicNeighborOperPeer)
object
lastOperStatusChange
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
localAddress
string

Local address used for this peer session, if known from oper

Exampleexample string
operStatus
boolean

True when the BGP session to this peer is operationally up (e.g. established)

Exampletrue
peerAsn
integer (int32)

Peer ASN from oper, if reported

Minimum0
Example123
remoteAddress
string

Peer address from device oper state (IPv4/IPv6; may include IPv6 zone id)

Exampleexample string
state
string

BGP FSM state for this peer session

ExampleENUM_VALUE
enabled
boolean
Exampletrue
holdTimer
integer (int32)
Minimum0
Example123
id
integer (int64)
Example1234567891011
keepaliveTimer
integer (int32)
Minimum0
Example123
localAddress
string
Exampleexample string
localInterface
string
Exampleexample string
maxPrefix
integer (int32)

Maximum number of prefixes that can be received from neighbor

Minimum0
Example10000
md5Password
string
Exampleexample string
multiHop
integer (int32)

Set when EBGP multi-hop functionality is enabled

Minimum0
Example5
peerAsn
integer (int32)
Minimum0
Example123
remoteAddress
string
Exampleexample string
removePrivateAs
boolean
Exampletrue
sendCommunity
boolean

Flag for sending standard, extended, and large communities

Exampletrue
state
string
ExampleENUM_VALUE
timeSinceLastOperChange
object (googleProtobufDuration)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
up
boolean
Exampletrue
bgpRedistributions
object (manaV2BgpRedistribute)
bgp
boolean
Exampletrue
connected
boolean
Exampletrue
dia
boolean
Exampletrue
ospfv2
boolean
Exampletrue
static
boolean
Exampletrue
carrier
string
Exampleexample string
circuitType
string
ExampleENUM_VALUE
connectionType
string
ExampleENUM_VALUE
coreLogicalInterfacesV2
Array of object (manaV2CircuitInterface)
object
adminStatus
boolean
Exampletrue
id
integer (int64)
Example1234567891011
index
integer (int64)
Example1234567891011
name
string
Exampleexample string
operStatus
boolean
Exampletrue
description
string
Exampleexample string
diaEnabled
boolean
Exampletrue
diaSnmpIndex
integer (int64)
Example1234567891011
discoveredPublicIp
string
Exampleexample string
dropMechanism
string
ExampleENUM_VALUE
id
integer (int64)
Example1234567891011
interfaceName
string
Exampleexample string
label
string
ExampleENUM_VALUE
lastResort
boolean
Exampletrue
linkDownSpeedMbps
integer (int32)
Minimum0
Example123
linkUpSpeedMbps
integer (int32)
Minimum0
Example123
loopback
boolean
Exampletrue
name
string
Exampleexample string
patAddresses
Array of string
string
Exampleexample string
privateIp
string
Exampleexample string
profile
object (manaV2QoSProfile)
kind
string
ExampleENUM_VALUE
profile
string
ExampleENUM_VALUE
queues
Array of object (manaV2QoSProfileQueue)
object
bandwidthPercent
integer (int32)
Minimum0
Example123
defaultQueue
boolean
Exampletrue
slaClass
string
ExampleENUM_VALUE
qosProfile
string
ExampleENUM_VALUE
qosProfileType
string
ExampleENUM_VALUE
snmpIndex
integer (int64)
Example1234567891011
staticRoutes
Array of object (manaV2StaticRoute)
object
administrativeDistance
integer (int32)
Minimum0
Example123
description
string
Exampleexample string
id
integer (int64)
Example1234567891011
nextHop
object (manaV2StaticRouteNexthop)
circuit
string
Exampleexample string
id
integer (int64)
Example1234567891011
metric
integer (int32)
Minimum0
Example123
nextHopAddress
string
Exampleexample string
nexthop
string
Exampleexample string
outgoingInterface
string
Exampleexample string
thirdPartyIpsecTunnel
string
Exampleexample string
nextHops
Array of object (manaV2StaticRouteNexthop)
object
circuit
string
Exampleexample string
id
integer (int64)
Example1234567891011
metric
integer (int32)
Minimum0
Example123
nextHopAddress
string
Exampleexample string
nexthop
string
Exampleexample string
outgoingInterface
string
Exampleexample string
thirdPartyIpsecTunnel
string
Exampleexample string
prefix
string
Exampleexample string
wanInterfaceV2
object (manaV2CircuitInterface)
adminStatus
boolean
Exampletrue
id
integer (int64)
Example1234567891011
index
integer (int64)
Example1234567891011
name
string
Exampleexample string
operStatus
boolean
Exampletrue
deviceId
integer (int64)
Minimum0
Example12345678910
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
Products
Company
Top Features
Solutions
Existing Users
Connect With Us
Sales and Support
Copyright © Abc Inc. All Rights Reserved