/v1/lan-segments

  • Updated on Nov 4, 2026
  • Published on Jul 9, 2026
  • P
 Prev Next
Get
/v1/lan-segments

Get LAN Segments for the current enterprise

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Query parameters
deviceId
integer (int64)
Example1234567891011
deviceIds
array of integer
Example[ 0 ]
Item Example1234567891011
filter
string
Exampleexample string
gatewayCloudProvider
string
ExampleENUM_VALUE
Responses
200

OK

Expand All
object
pageInfo
object (commonPageInfo)
currentPage
integer (int32)

The page number we are currently on (required)

Minimum0
Example1
endCursor
string

Cursor pointing to the last record on the current page

Examplexxxxxxy
hasNextPage
boolean

An indicator whether there is a page after this one in the resultset based on current position

Exampletrue
hasPrevPage
boolean

An indicator whether there is a page before this one in the resultset based on current position

Exampletrue
startCursor
string

Cursor pointing to the first record on the current page

Examplexxxxxx
totalPages
integer (int32)

The number of pages in the complete resultset based on the current length of the page (required)

Minimum0
Example4
totalRecords
integer (int32)

Describes the total number of records in the complete resultset (required)

Minimum0
Example400
segments
Array of object (manaV2Vrf)
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
description
string
Exampleexample string
dhcpSubnets
Array of object (manaV2DhcpServerPool)
object
defaultLeaseTimeSecs
integer (int32)
Minimum0
Example123
description
string
Exampleexample string
domainName
string
Exampleexample string
gateway
string
Exampleexample string
id
integer (int64)
Example1234567891011
interface
string
Exampleexample string
ipPrefix
string
Exampleexample string
ipVersion
integer (int32)
Minimum0
Example123
leases
Array of object (manaV2DhcpLease)
object
endsAt
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
id
integer (int64)
Example1234567891011
ipAddress
string
Exampleexample string
macAddress
string
Exampleexample string
vrf
string
Exampleexample string
maxLeaseTimeSecs
integer (int32)
Minimum0
Example123
minLeaseTimeSecs
integer (int32)
Minimum0
Example123
name
string
Exampleexample string
nameservers
object (manaV2DnsServers)
primary
string
Exampleexample string
secondary
string
Exampleexample string
ranges
Array of object (manaV2DhcpServerIpRange)
object
end
string
Exampleexample string
start
string
Exampleexample string
staticLeases
Array of object (manaV2DhcpStaticLease)
object
hostname
string
Exampleexample string
id
integer (int64)
Example1234567891011
ipAddress
string
Exampleexample string
macAddress
string
Exampleexample string
vrf
string
Exampleexample string
totalAddresses
integer (int64)
Minimum0
Example12345678910
utilization
integer (int32)
Minimum0
Example123
enterpriseId
integer (int64)
Example1234567891011
function
string
Exampleexample string
id
integer (int64)
Example1234567891011
ipfixExporters
Array of object (manaV2IpfixExporter)
object
destinationAddress
string
Exampleexample string
destinationPort
integer (int32)
Minimum0
Example123
errorMessage
string
Exampleexample string
globalId
integer (int64)
Example1234567891011
id
integer (int64)
Example1234567891011
monitoredSegments
Array of string
string
Exampleexample string
name
string
Exampleexample string
sampleMode
string
Exampleexample string
sampleRate
integer (int64)
Example1234567891011
sourceAddress
string
Exampleexample string
sourceInterface
string
Exampleexample string
sourceSegment
string
Exampleexample string
status
string
ExampleENUM_VALUE
vrfId
integer (int64)
Example1234567891011
vrfName
string
Exampleexample string
name
string
Exampleexample string
natRuleset
string
Exampleexample string
networks
Array of string
string
Exampleexample string
ospfv2Process
object (manaV2OspFv2Process)
adminDistance
integer (int32)

Administrative Distance for routes installed

Minimum0
Example100
areas
Array of object (manaV2OspfArea)
object
areaId
string
Exampleexample string
bfd
object (manaV2BfdInstance)
enabled
boolean
Exampletrue
minimumInterval
integer (int32)
Minimum0
Example123
multiplier
integer (int32)
Minimum0
Example123
bfdNeighbors
Array of object (manaV2BfdNeighbor)
object
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
id
integer (int64)
Example1234567891011
interfaces
Array of object (manaV2OspfInterface)
object
authentication
object (manaV2OspfAuthentication)
key
string

Shared secret for OSPFv2 MD5 authentication on this interface

Exampleexample string
keyId
integer (int32)

Identifier of the OSPFv2 MD5 authentication key configured on this interface

Minimum0
Example123
bfd
object (manaV2BfdInstance)
enabled
boolean
Exampletrue
minimumInterval
integer (int32)
Minimum0
Example123
multiplier
integer (int32)
Minimum0
Example123
bfdNeighbors
Array of object (manaV2BfdNeighbor)
object
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
cost
integer (int32)
Minimum0
Example123
deadInterval
integer (int32)
Minimum0
Example123
deadIntervalValue
integer (int32)
Minimum0
Example123
drPriority
integer (int32)
Minimum0
Example123
helloInterval
integer (int32)
Minimum0
Example123
helloIntervalValue
integer (int32)
Minimum0
Example123
id
integer (int64)
Example1234567891011
ifIndex
integer (int32)
Minimum0
Example123
interface
string
Exampleexample string
maxTransmissionUnit
integer (int32)
Minimum0
Example123
mtuIgnore
boolean
Exampletrue
prefixSid
integer (int32)
Minimum0
Example123
retransmitInterval
integer (int32)
Minimum0
Example123
retransmitIntervalValue
integer (int32)
Minimum0
Example123
type
string
ExampleENUM_VALUE
name
string
Exampleexample string
type
string
ExampleENUM_VALUE
autoRouterId
boolean
Exampletrue
defaultOriginate
string
ExampleENUM_VALUE
id
integer (int64)
Example1234567891011
redistributedProtocols
Array of object (manaV2OspfRedistribute)
object
metric
integer (int32)
Minimum0
Example123
metricType
string
ExampleENUM_VALUE
redistType
string
ExampleENUM_VALUE
routerId
string
Exampleexample string
ospfv3Process
object (manaV2OspFv3Process)
adminDistance
integer (int32)

Administrative Distance for routes installed

Minimum0
Example100
areas
Array of object (manaV2OspfArea)
object
areaId
string
Exampleexample string
bfd
object (manaV2BfdInstance)
enabled
boolean
Exampletrue
minimumInterval
integer (int32)
Minimum0
Example123
multiplier
integer (int32)
Minimum0
Example123
bfdNeighbors
Array of object (manaV2BfdNeighbor)
object
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
id
integer (int64)
Example1234567891011
interfaces
Array of object (manaV2OspfInterface)
object
authentication
object (manaV2OspfAuthentication)
key
string

Shared secret for OSPFv2 MD5 authentication on this interface

Exampleexample string
keyId
integer (int32)

Identifier of the OSPFv2 MD5 authentication key configured on this interface

Minimum0
Example123
bfd
object (manaV2BfdInstance)
enabled
boolean
Exampletrue
minimumInterval
integer (int32)
Minimum0
Example123
multiplier
integer (int32)
Minimum0
Example123
bfdNeighbors
Array of object (manaV2BfdNeighbor)
object
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
cost
integer (int32)
Minimum0
Example123
deadInterval
integer (int32)
Minimum0
Example123
deadIntervalValue
integer (int32)
Minimum0
Example123
drPriority
integer (int32)
Minimum0
Example123
helloInterval
integer (int32)
Minimum0
Example123
helloIntervalValue
integer (int32)
Minimum0
Example123
id
integer (int64)
Example1234567891011
ifIndex
integer (int32)
Minimum0
Example123
interface
string
Exampleexample string
maxTransmissionUnit
integer (int32)
Minimum0
Example123
mtuIgnore
boolean
Exampletrue
prefixSid
integer (int32)
Minimum0
Example123
retransmitInterval
integer (int32)
Minimum0
Example123
retransmitIntervalValue
integer (int32)
Minimum0
Example123
type
string
ExampleENUM_VALUE
name
string
Exampleexample string
type
string
ExampleENUM_VALUE
defaultOriginate
string
ExampleENUM_VALUE
id
integer (int64)
Example1234567891011
redistributedProtocols
Array of object (manaV2OspfRedistribute)
object
metric
integer (int32)
Minimum0
Example123
metricType
string
ExampleENUM_VALUE
redistType
string
ExampleENUM_VALUE
routerId
string
Exampleexample string
version
integer (int32)
Minimum0
Example123
overlayFilters
object (manaV2OverlayFilters)
inboundFilter
string
Exampleexample string
outboundFilter
string
Exampleexample string
routable
boolean
Exampletrue
routeDistinguisher
string
Exampleexample string
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
syslogTargets
Array of object (manaV2SyslogCollector)
object
destinationHost
string
Exampleexample string
destinationPort
integer (int32)
Minimum0
Example123
enabled
boolean
Exampletrue
errorMessage
string
Exampleexample string
globalId
integer (int64)
Example1234567891011
id
integer (int64)
Example1234567891011
name
string
Exampleexample string
severity
string
ExampleENUM_VALUE
sourceInterface
string
Exampleexample string
status
string
ExampleENUM_VALUE
transport
string
ExampleENUM_VALUE
vrfId
integer (int64)
Example1234567891011
vrfName
string
Exampleexample string
trafficRuleset
string
Exampleexample string
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