URI Parameters

URI parameters are reserved keys that are used to modify the functionality of API calls, override HTTP header values, and bundle multiple API requests together. Below is a list of available URI keys and descriptions of their functionality.

URI Key Description
fields Applies a RESTful action to multiple collections/elements. Each request path is separated by a comma. Requested data within a field is returned using the path by replacing ‘/’ characters with ‘ ‘ characters.
method Allows passing RESTful action (GET, PUT, POST, & DELETE) in URI. This overrides the HTTP header method.
apply Allows the request to be applied at the given timestamp without restarting. Currently, only apply=now is supported.
token Authorizes an API call. A token is returned after a successful login. If a user is logged in, the whoami request will return that user’s current token.
inactivity Allows requests to be made without bumping the user’s token expiration date. This is useful for automated polling loops that would otherwise allow a user to timeout due to inactivity. (inactivity=true)
session Reserved for internal use. This member will be overwritten.
data Allows you to pass a JSON Object in the URI.
default Retrieves the factory defaults of a collection when using a RESTful GET request, and sets a collection to its factory defaults when using a RESTful PUT request. (default=true)
version Sets the API version expectation for that request.
username Stores a user’s login name. Used for logging into the API.
password Stores a user’s login password. Used for logging into the API.
logoutUser Names the user you are logging out. Use this parameter for an api/logout request only.

Example

Behavior of the “fields” key:

GET https://192.168.2.1/api?fields=lan/ip,serial/client/enabled&method=GET

Status: HTTP/1.1 200 OK
{
    "code" : 200, 
    "result" : {
        "lan_ip" : "192.168.2.1",
        "serial_client_enabled" : false
    },
    "status" : "success"
}