Request Query Parameters

Request query parameters are appended to the API request URL with the ? operator and are of the form parameter=value. Multiple query parameters can be combined using the & operator. Some query parameters allow more than one value, separated by a comma with no space after.

To support pagination and other query functions, the Cisco NAE REST API reserves all parameters starting with $ as Cisco NAE REST API keywords. Any keyword not starting with $ is assumed to be specific to the assured entity and is handled uniquely by the API.

Query Parameter Examples

The following query requests detailed epoch records, delivered two to a page, beginning with the first page, which is page 0.

GET  /nae/api/v1/epochs?$page=0&$size=2

The following query requests critical and major system events for an epoch. Two severity level values are specified, separated by a comma.

GET /nae/api/v1/event-services/smart-events?$epoch_id={EPOCHID}&category=SYSTEM&severity=EVENT_SEVERITY_CRITICAL,EVENT_SEVERITY_MAJOR