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

Retrieve subnet information for an appliance

get
http://127.0.0.1:8080/subnets

Fetches subnet configuration, peer information, and module statistics for a specified appliance. Uses version-appropriate API endpoints internally (/subnets/all for pre-8.1.9.1, /subnets3/all for 8.1.9.1+). When cached=true, returns stored data from Orchestrator; when cached=false, queries the appliance directly.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
required
Defaults to false

When true, retrieves subnet data from Orchestrator's cached database. When false, queries the appliance directly for real-time data.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

string

Filter routes by subnet in CIDR notation. Supports both IPv4 (e.g., '192.168.1.0/24') and IPv6 addresses.

Responses

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?