v1

latestOpenAPI 3.0.2GNU Free Documentation License2026-07-176924101.2 KB
Objects

Get objects with filters

Returns all objects available to the current user, optionally filtered. Supports filtering by name, class, parent, zone, geographical area, state, and custom attributes.

get/objects

Query parameters

areastring

Geographical area filter as "lat1,lon1,lat2,lon2" (bounding box)

classstring

Comma-separated list of object class names (e.g., "Node,Container")

namestring

Name filter (glob pattern or regex if regex=true)

parentinteger

Filter objects that are children of given parent object ID

primaryNamestring

Filter nodes by primary name (glob pattern or regex if regex=true)

statestring

Filter nodes by state flags (integer or hex with 0x prefix)

topLevelOnlyboolean

Return only top-level objects

regexboolean

Treat name and custom attribute filters as regex patterns

zonestring

Comma-separated list of zone UINs

@{attributeName}string

Custom attribute filter. Use @attributeName=value format

Response

List of objects