Differences among REST API versions

Resources, attributes, and behaviors might differ between different versions of the REST API, and a switch supports access through multiple versions of the REST API.

ArubaOS-CX Network Analytics Engine scripts

URIs that specify monitors in Network Analytics Engine scripts must be REST v1 URIs.

Aruba OS real-time notifications subsystem

URIs that identify resources in the ArubaOS-CX real-time notifications subsystem must be REST v1 URIs.

Interfaces and ports

The REST v10.04 API provides the interfaces resource to configure and get information about switch ports and interfaces of all types. The ports resource is not supported by the REST v10.04 API.

GET method

The GET method query parameters differ between REST v1 and REST v10.04. In REST v10.04:

  • The REST v10.04 selector parameter includes a value of writable, which enables you to get only the mutable attributes of a resource.

  • The REST v1 parameters filter and count are not supported by the REST v10.04 API.

  • The use of wildcards in GET requests is not supported by the REST v10.04 API.

  • The REST v1 depth parameter has a default of 0 and a range of 0 through 3.

    The REST v10.04 depth parameter has a default of 1 and a range of 1 through 4. The REST v10.04 depth=1 is equivalent to the REST v1 depth=0, and so forth.

Resource collections

In REST v10.04, the members of a resource collection are represented as JSON objects, where the key is the index and the value is the URI of the resource.

For example, the response to a GET request to /rest/v10.04/system/vrfs is the following: 

{
  "default": "/rest/v10.04/system/vrfs/default",
  "mgmt": "/rest/v10.04/system/vrfs/mgmt"
}

In contrast, the response to a GET request to /rest/v1/system/vrfs on the same switch is the following: 

[
  "/rest/v1/system/vrfs/default",
  "/rest/v1/system/vrfs/mgmt"
]