Get Appliance System State Information

get

http://127.0.0.1:8080/systemInfo

Retrieves comprehensive system state information for an appliance including hardware details, software version, licensing status, uptime, and alarm summaries. Can fetch data from cache or directly from the appliance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE'). When omitted, results are returned for all appliances.

cached

boolean

Defaults to true

Controls data source: 'true' fetches from Orchestrator cache (faster), 'false' fetches directly from the appliance (real-time). Default is 'true'. When cached, uptime is dynamically recalculated based on last sync time.

discoveredId

string

ID of a discovered (unapproved) appliance. Required when using 'url' parameter and mutually exclusive with 'nePk'. Used for querying appliances in discovered state before approval.

url

string

The API URL path after 'rest/json/' to query on the appliance. Required when using 'discoveredId' and mutually exclusive with 'nePk'. Suffix 'ForDiscovered' is automatically removed before querying.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved system state information

400Bad Request - Invalid parameters provided

404Not Found - Appliance or resource not found

500Internal Server Error - Failed to retrieve system info