Service Manual
REST Authentication
The REST API authenticates and authorizes the user based on the Dell Networking OS AAA configuration.
You can locally configure or validate through the AAA infrastructure. For more information about the AAA
Accounting mode, see the Dell Networking OS Configuration Guide, Security chapter.
The Dell Networking OS CLI user level privilege dictates the level of the REST API access. Users with privilege
level 0 or 1 have read-only access; the allowed REST API method is GET. Users with privilege levels 2 through
15 have read-write access in REST API. The allowed methods are GET, PATCH, PUT, POST, and DELETE.
For information about the privilege level command, see the Dell Networking OS Command Line Reference
Guide, Security chapter.
Request Query Parameters
Following are the various request query parameters supported on REST.
• deep — Retrieves a resource with all the subresources inline.
• shallow — Retrieves a resource with no subresources inline.
• select — Client uses to select the nodes and subresources.
• with-defaults — Client uses to control and display the default data in GET request.
To request a filtered partial response, use the select query parameter in the following patterns to specify the
nodes and subresources.
• Use a semicolon separated list to select multiple nodes.
• Use a/b to select a node b that is nested within node a. Use a/b/c to select a node c nested within b.
• Use expressions in parentheses ( ) after any selected node to request specific subnodes.
• Use the wildcard notation within parentheses (*) to specify all sub nodes of a specific node.
NOTE: The node a/b/c;a/b/d is equivalent to a/b(c;d).
The following request selects the routes name and next-hop/name nodes:
GET
/running/sys/routes/inet/route/10.20.0.0,16?select=name;next-hop(name)
REST API 161