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

Create a new routing segment

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

Creates a new routing segment (VRF) in Orchestrator. The segment ID is auto-generated and returned in the response. Segment names must be unique, contain only alphanumeric characters and underscores, and cannot be 'Default'. Creating a segment automatically associates it with all overlays and creates corresponding firewall zones. Changes trigger orchestration to all managed appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

JSON object containing the segment name. The 'name' field is required and must be unique across all segments. Only alphanumeric characters and underscores are allowed. The segment ID is auto-generated by the system.

Request body for creating a new routing segment (VRF). Only the name field is required; the segment ID is auto-generated by the system.

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

Unique name for the segment. Must contain only alphanumeric characters and underscores. Cannot be 'Default' (reserved for segment ID 0).

Responses

401

Unauthorized. User lacks READ_WRITE permission to create segments.

500

Internal server error. Failed to save segment configuration to database.

Updated about 13 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 13 hours ago

Did this page help you?