HomeGuidesAPI Reference
API Reference

Retrieve HA peer metadata for appliances

Returns cached High Availability (HA) peer data including peer nePk, HA group name, and device status. When nePk is omitted, returns HA peer information for all appliances in HA groups. When nePk is provided, returns HA peer information for the specified appliance only. Supports ETag-based caching using If-None-Match header for conditional requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
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.

Headers
string

ETag value from a previous response for conditional request. If the data has not changed, the server returns HTTP 304 Not Modified.

Responses

304

Not Modified. The HA peer metadata has not changed since the last request. Returned when the If-None-Match header matches the current ETag.

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