Configure the BGP routing plugin on an appliance

Request

Update the base BGP settings stored in config._bgp for a node. This endpoint only updates the top-level BGP fields: enabled, id, asn, and client.

Use the peer-group and policy endpoints under /v2/node/{nodeID}/config/network/bgp/... to manage nested BGP objects without replacing the full structure. Read the current BGP config from GET /node/{nodeID}.

Requires nodes::configure:network permission.

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

Bodyapplication/jsonrequired

BGP top-level update request

enabledbooleanrequired

Whether BGP is enabled on the node

idstringrequired

Router ID for the local BGP speaker

Example:"10.0.0.1"

asninteger, [ 1 .. 65534 ]required

Local autonomous system number

Example:65001

clientbooleanrequired

Whether the local speaker operates in client mode

curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/config/network/bgp' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "id": "10.0.0.1",
    "asn": 65001,
    "client": true
  }'

Responses

OK

Response

No content