...
Query Parameter | Possible Values |
---|---|
properties | Array of property names. If provided only the properties specified will be returned (instead of the whole document. eg: properties=["configuration.customer", "configuration.group"] By default the nodes UUID is returned by default if no properties are given |
page | (int) Which page of the requested document to returned |
limit | (int) How many results are returned, defaults to 25 |
filter | Array of key=value pairs, but coded in an array. Applied to the list of results in the order they are given. If an application key is provided that will be applied first. eg: filter={"configuration.group":"NMIS8","catchall.data.nodestatus": "reachable"} (which is "configuration.group"="NMIS8" AND "catchall.data.nodestatus"="reachable" ) |
sort | 0 | 1 : sort the response with node.names ascending or descending |
redact | 0 | 1 : redact the information in nodes.configuration . |
Examples of how to use the request modifiers can be found in the response blocks below. In general, the queries will look something like this:
...