Update a BGP peer in a peer group

Request

Update a remote BGP peer in the specified peer group.

If secret is omitted, the existing secret is preserved.

Requires nodes::configure:network permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

peerGroupIdstringrequired

BGP peer group ID

peerIdstringrequired

BGP peer ID

Bodyapplication/jsonrequired

BGP peer update request

namestringrequired

Peer name

Example:"isp-router-1"

ipstringrequired

IPv4 address of the remote peer

Example:"10.0.0.254"

asninteger, [ 1 .. 65534 ]required

Remote autonomous system number

Example:65000

secretstring

Optional MD5 authentication secret. Omit to preserve the existing secret.

curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers/{peerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "isp-router-1",
    "ip": "10.0.0.254",
    "asn": 65000,
    "secret": "string"
  }'

Responses

OK

Response

No content