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

Retrieve network interface state and configuration data

get
http://127.0.0.1:8080/interfaceState

Retrieves network interface configuration and state information for a specified appliance. Data can be fetched from the Orchestrator database cache or directly from the appliance. When fetching from the appliance, the cache is automatically updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

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

string
enum
Defaults to true

Controls the data source. When true, retrieves from Orchestrator database cache. When false, fetches directly from the appliance and updates the cache. Default is true if not specified.

Allowed:
Responses

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

Did this page help you?