HomeGuidesAPI Reference
API Reference

Get detailed WebSocket reachability status from Orchestrator

Retrieves detailed WebSocket connectivity status for an appliance. Returns direct GMS WebSocket status, Portal WebSocket status with end-to-end encryption indicator, preferred communication channel, and timing configuration (ping frequency, idle timeout). Validates that appliance exists in Orchestrator cache before processing.

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').

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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