/v1/devices/{deviceId}/interfaces

Updated on Nov 4, 2026
Published on Jul 9, 2026

Prev Next

Get

Get interfaces for the given device

Security

API Key: jwtAuth

Header parameter nameauthorization

Use Bearer <token>

Header parameters

Authorization

stringRequired

Bearer token. Format: Bearer <your_token_here>

Path parameters

deviceId

integer (int64) Required

Example1234567891011

Responses

200

Expand All

object

interfaces

Array of object (manaV2Interface)

object

alias

string

Exampleexample string

circuit

string

Exampleexample string

circuitName

string

Exampleexample string

configUpdatedAt

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

configuredMaxTransmissionUnit

integer (int32)

Minimum0

Example123

description

string

Exampleexample string

duplex

string

Exampleexample string

enabled

boolean

Exampletrue

gatewayAddressV4

string

Exampleexample string

gatewayAddressV6

string

Exampleexample string

integer (int64)

Example1234567891011

ipSec

object (manaV2InterfaceIPsec)

antiReplayWindowSize

integer (int32)

Minimum0

Example123

dhGroup

string

ExampleENUM_VALUE

dpdInterval

integer (int32)

Minimum0

Example123

encryptionAlg

string

ExampleENUM_VALUE

esn

boolean

Exampletrue

establishedTime

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

ikeIntegrity

string

ExampleENUM_VALUE

ipsecEncryptionAlg

string

ExampleENUM_VALUE

ipsecIntegrity

string

ExampleENUM_VALUE

label

string

ExampleENUM_VALUE

localAddress

string

Exampleexample string

localCircuit

string

Exampleexample string

localIkePeerIdentity

string

Exampleexample string

localIkesaSpi

integer (int64)

Minimum0

Example12345678910

localPort

integer (int32)

Minimum0

Example123

negotiatedAlgo

string

Exampleexample string

operState

boolean

Exampletrue

perfectForwardSecrecy

string

Exampleexample string

presharedKey

string

Exampleexample string

protocol

string

Exampleexample string

reauthInterval

integer (int64)

Example1234567891011

rekeyInterval

integer (int64)

Example1234567891011

remoteAddress

string

Exampleexample string

remoteIkePeerIdentity

string

Exampleexample string

remoteIkesaSpi

integer (int64)

Minimum0

Example12345678910

remotePort

integer (int32)

Minimum0

Example123

ipv4

object (manaV2InterfaceAddress)

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

ipv6

object (manaV2InterfaceAddress)

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

ipv6Addresses

Array of object (manaV2InterfaceAddress)

object

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

lagInterface

object (manaV2LagInterface)

integer (int64)

Example1234567891011

lacpConfig

object (manaV2LacpConfig)

mode

string

ExampleENUM_VALUE

timer

string

ExampleENUM_VALUE

members

Array of integer

integer (int64)

Example1234567891011

minimumMembers

integer (int32)

Minimum0

Example123

lan

string

Exampleexample string

lldpEnabled

boolean

Exampletrue

macsec

object (manaV2InterfaceMaCsec)

enabled

boolean

Exampletrue

encryptionEnforcementMode

string

ExampleENUM_VALUE

keyServerPriority

integer (int64)

Example1234567891011

pskConfigurations

Array of object (manaV2PskConfiguration)

object

cak

string

The Connection Authentication Key (CAK)

Example1234567890abcdef1234567890abcdef

cakCryptographicAlgorithm

string

The cryptographic algorithm for the CAK, SAK Cipher Suite is implicitly selected based on this field. (required)

ExampleAES_128_CMAC

ckn

string

The Connection Key Name (CKN) (required)

ExampleCorp-MACsec-CKN

nickname

string

The nickname of the PSK (required)

ExamplePSK1

startTime

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

useXpnForCipherSuite

boolean

Whether to use XPN for the cipher suite. If true, AES_128_GCM_XPN or AES_256_GCM_XPN is selected based on the cmac algorithm. If false, AES_128_GCM or AES_256_GCM is selected based on the cmac algorithm.

Exampletrue

sakConfigurations

Array of object (manaV2SakConfiguration)

object

cipherSuite

string

ExampleENUM_VALUE

lagMemberInterfaceId

integer (int64)

The interface ID (required for when each lag member has a different MACsec configuration - when split_sak_config_by_lag_member is true) (required)

Example1

nullableRekeyInterval

object (manaV2NullableMaCsecRekeyInterval)

rekeyInterval

integer (int64)

Example1234567891011

nullableReplayProtectionWindowSize

object (manaV2NullableMaCsecReplayProtectionWindowSize)

replayProtectionWindowSize

integer (int64)

Example1234567891011

rekeyInterval

integer (int64)

Example1234567891011

replayProtectionWindowSize

integer (int64)

Example1234567891011

splitSakConfigByLagMember

boolean

Exampletrue

transparentVlan

boolean

Exampletrue

maxTransmissionUnit

integer (int32)

Minimum0

Example123

name

string

Exampleexample string

operUpdatedAt

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

phyAddress

string

Exampleexample string

pppoeInterface

object (manaV2PpPoEInterface)

authenticationType

string

ExampleENUM_VALUE

dnsServers

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

lastIpcpCloseReason

string

Exampleexample string

lastIpv6CpCloseReason

string

Exampleexample string

lastLcpCloseReason

string

Exampleexample string

lcpEchoFailure

integer (int32)

Minimum0

Example123

lcpEchoInterval

integer (int32)

Minimum0

Example123

maximumReceiveUnit

integer (int32)

Minimum0

Example123

password

string

Exampleexample string

peerIpv4Address

string

Exampleexample string

peerIpv6Address

string

Exampleexample string

pppConnectTimeout

integer (int32)

Minimum0

Example123

serverMacAddress

string

Exampleexample string

serverName

string

Exampleexample string

sessionId

integer (int32)

Minimum0

Example123

state

string

ExampleENUM_VALUE

username

string

Exampleexample string

pppoeInterfaces

Array of object (manaV2Interface)

protocol

string

ExampleENUM_VALUE

securityZone

string

Exampleexample string

sfpOpticalStrength

Array of object (manaV2InterfaceSfpOpticalStrength)

object

index

integer (int32)

Minimum0

Example123

rxPower

number (float)

Example12.34

txBias

number (float)

Example12.34

txPower

number (float)

Example12.34

voltage

number (float)

Example12.34

speedMbps

integer (int32)

Minimum0

Example123

subinterfaces

Array of object (manaV2InterfaceVlan)

object

alias

string

Exampleexample string

circuit

string

Exampleexample string

configUpdatedAt

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

description

string

Exampleexample string

duplex

string

Exampleexample string

enabled

boolean

Exampletrue

gatewayAddressV4

string

Exampleexample string

gatewayAddressV6

string

Exampleexample string

integer (int64)

Example1234567891011

ipv4

object (manaV2InterfaceAddress)

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

ipv6

object (manaV2InterfaceAddress)

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

ipv6Addresses

Array of object (manaV2InterfaceAddress)

object

address

string

Exampleexample string

dhcpClient

boolean

Exampletrue

dhcpRelay

object (manaV2DhcpRelay)

dhcpv4Relays

Array of string

string

Exampleexample string

dhcpv6Relays

Array of string

string

Exampleexample string

integer (int64)

Example1234567891011

dhcpServer

boolean

Exampletrue

origin

string

ExampleENUM_VALUE

vrrpGroup

object (manaV2VrrpGroup)

acceptMode

boolean

Exampletrue

allowInterOperability

boolean

Exampletrue

description

string

Exampleexample string

effectivePriority

integer (int32)

Example123

enabled

boolean

Exampletrue

groupMembers

Array of object (manaV2VRRPGroupMember)

object

circuit

string

Exampleexample string

deviceId

integer (int64)

Example1234567891011

effectivePriority

integer (int32)

Example123

hostname

string

Exampleexample string

interface

string

Exampleexample string

lan

string

Exampleexample string

localIpAddress

string

Exampleexample string

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

integer (int64)

Example1234567891011

name

string

Exampleexample string

preempt

boolean

Exampletrue

priority

integer (int32)

Example123

state

string

ExampleENUM_VALUE

trackedInterfaces

Array of object (manaV2VRRPGroupInterfacePriorityDecrement)

object

interface

string

Exampleexample string

priorityDecrement

integer (int32)

Minimum0

Example123

virtualIpAddress

string

Exampleexample string

virtualMacAddress

string

Exampleexample string

lan

string

Exampleexample string

macAddress

string

Exampleexample string

maxTransmissionUnit

integer (int32)

Minimum0

Example123

name

string

Exampleexample string

operUpdatedAt

object (googleProtobufTimestamp)

nanos

integer (int32)

Example123

seconds

integer (int64)

Example1234567891011

parentMacAddress

string

Exampleexample string

pppoeInterfaces

Array of object (manaV2Interface)

securityZone

string

Exampleexample string

speedMbps

integer (int32)

Minimum0

Example123

tcpMss

integer (int32)

Minimum0

Example123

tcpMssV4

integer (int32)

Minimum0

Example123

tcpMssV6

integer (int32)

Minimum0

Example123

boolean

Exampletrue

vlan

integer (int32)

Minimum0

Example123

tcpMss

integer (int32)

Minimum0

Example123

tcpMssV4

integer (int32)

Minimum0

Example123

tcpMssV6

integer (int32)

Minimum0

Example123

type

string

ExampleENUM_VALUE

boolean

Exampletrue

vrfFunctionId

integer (int32)

Minimum0

Example123

vrfName

string

Exampleexample string

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