HomeGuidesAPI Reference
API Reference

Get routing segments

Retrieves routing segment (VRF) configurations from Orchestrator. Without the id parameter, returns all segments as a map keyed by segment ID. With an id parameter, returns only the specified segment. The default segment (id=0, name='Default') is always included when retrieving all segments. Segment names must be unique and contain only alphanumeric characters and underscores.

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

Unique identifier of a routing segment to retrieve. If omitted, returns all segments. Use 0 for the default segment.

Responses

401

Unauthorized. User lacks READ or READ_WRITE permission.

500

Internal server error. Failed to retrieve segment configuration from database.

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