HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. vrf

Update an existing routing segment

put
http://127.0.0.1:8080/vrf/config/segments

Updates an existing routing segment (VRF) configuration in Orchestrator. Only the segment name and comment can be modified; the segment ID cannot be changed. Validates that the new name is unique, contains only alphanumeric characters and underscores, and is not 'Default'. Changes trigger orchestration to all managed appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
1 to 65400

Unique identifier of the routing segment to update. Must be a positive integer (1-65400). The default segment (id=0) cannot be modified via this endpoint.

Body Params

JSON object containing the updated segment properties. The 'name' field is required and must be unique across all segments.

Request body for updating an existing routing segment (VRF). Only name and comment can be modified.

string
required
length ≥ 1
^[_A-Za-z\d]+$

New name for the segment. Must be unique across all segments, contain only alphanumeric characters and underscores, and cannot be 'Default'.

string

Optional description or notes for the segment.

Responses
204

Successfully updated the routing segment. Changes are queued for orchestration to all managed appliances.

401

Unauthorized. User lacks READ_WRITE permission to modify segments.

500

Internal server error. Failed to update segment configuration in database.

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?