Put
/v1/pvif/{id}
Update a gateway Public VIF service
Security
API Key: jwtAuth
Header parameter nameauthorization
Use Bearer <token>
Header parameters
Authorization
stringRequired
Bearer token. Format: Bearer <your_token_here>
Path parameters
id
integer (int64) Required
Producer service id
Example1234567891011
Body parameters
object
configuration
object (manaV2PublicVifGatewayWriteRequest) Required
advertisement
object (manaV2SiteInformation)
siteLists
Array of integer
integer (int64)
Example1234567891011
sites
Array of integer
integer (int64)
Example1234567891011
consumerLanSegments
object Required
property*
object (manaV2PublicVifGatewayConsumerLanDevices) additionalProperties
consumerPrefixes
Array of string
string
Allow prefixes for this consumer LAN; empty means 0.0.0.0/0
Exampleexample string
coveringPrefixes
Array of string
string
Prefixes monitored for this service; empty means 0.0.0.0/0
Exampleexample string
gatewayBgpNeighbors
object Required
property*
object (manaV2BgpNeighborConfig) additionalProperties
addressFamilies
object
property*
object (manaV2NullableBgpNeighborAddressFamilyConfig) additionalProperties
family
object (manaV2BgpNeighborAddressFamilyConfig)
addressFamily
string
ExampleENUM_VALUE
inboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
outboundPolicy
object (manaV2NullablePolicyName)
policy
string
Exampleexample string
allowAsIn
object (manaV2NullableAllowAsIn)
count
integer (int32)
Minimum0
Example123
asOverride
boolean
Exampletrue
bfd
object (manaV2NullableBfdInstanceConfig)
bfd
object (manaV2BfdInstanceConfig)
enabled
boolean
Exampletrue
localMultiplier
integer (int32)
Minimum0
Example123
minimumInterval
integer (int32)
Minimum0
Example123
defaultOriginate
string
ExampleENUM_VALUE
ebgpMultihopTtl
object (manaV2NullableEbgpConfig)
multiHop
integer (int32)
Minimum0
Example123
enabled
boolean
Exampletrue
holdTimer
integer (int32)
Minimum0
Example123
holdTimerValue
object (manaV2NullableHoldTimer)
timer
integer (int32)
Minimum0
Example123
keepaliveTimer
integer (int32)
Minimum0
Example123
keepaliveTimerValue
object (manaV2NullableKeepAliveTimer)
timer
integer (int32)
Minimum0
Example123
localAddress
string
Exampleexample string
localInterface
object (manaV2NullableInterfaceName)
interface
string
Exampleexample string
maxPrefixValue
object (manaV2NullableMaxPrefix)
maxPrefix
integer (int32)
Minimum0
Example123
md5Password
object (manaV2NullableMd5Password)
md5Password
string
Exampleexample string
peerAsn
integer (int32)
Minimum0
Example123
remoteAddress
string
Exampleexample string
removePrivateAs
boolean
Exampletrue
sendCommunity
boolean
Exampletrue
lanSegmentId
integer (int64) Required
Producer LAN segment (VRF) on gateway appliances (required)
Example1234567891011
natPrefixStrategy
object (manaV2PublicVifGatewayNatPrefixStrategy) Required
centralized
object (manaV2PublicVifGatewayCentralizedNat)
consumerPrefix
object Required
property*
string additionalProperties
Exampleexample string
decentralized
object (manaV2PublicVifGatewayDecentralizedPrefixes)
prefixes
object Required
property*
string additionalProperties
Exampleexample string
regionId
integer (int32) Required
Graphiant region for gateway appliances (required)
Example123
serviceName
string Required
Producer service name (letters, digits, hyphens only) (required)
Exampleexample string
storageProvider
string Required
Storage provider; each gateway appliance must match region and provider (required)
ExampleENUM_VALUE
Responses
200
OK
object
advertiseAllSites
boolean
True when consumer scope is all symmetric sites (snapshotted on create and update); false when advertisement lists explicit sites or site lists
Exampletrue
advertisement
object (manaV2SiteInformation)
siteLists
Array of integer
integer (int64)
Example1234567891011
sites
Array of integer
integer (int64)
Example1234567891011
consumerLanSegments
object
property*
object (manaV2PublicVifGatewayConsumerLanDevices) additionalProperties
consumerPrefixes
Array of string
string
Allow prefixes for this consumer LAN; empty means 0.0.0.0/0
Exampleexample string
coveringPrefixes
Array of string
string
Prefixes monitored for this service
Exampleexample string
gatewayBgpNeighbors
object
property*
object (manaV2BgpNeighbor) additionalProperties
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
id
integer (int64)
Producer service id
Example1234567891011
lanSegmentId
integer (int64)
Producer LAN segment (VRF) id
Example1234567891011
natPrefixStrategy
object (manaV2PublicVifGatewayNatPrefixStrategy)
centralized
object (manaV2PublicVifGatewayCentralizedNat)
consumerPrefix
object
property*
string additionalProperties
Exampleexample string
decentralized
object (manaV2PublicVifGatewayDecentralizedPrefixes)
prefixes
object
property*
string additionalProperties
Exampleexample string
regionId
integer (int32)
Graphiant region for gateway appliances
Example123
serviceName
string
Service display name
Exampleexample string
storageProvider
string
Storage provider for gateway appliances
ExampleENUM_VALUE