Sign in

v51

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01245104440.0 KB
Objects

List objects

Retrieve a list of objects (with optional filter).

get/v1/objects

Query parameters

filterstring

Optional filter string. If provided, only objects with name or alias containing given string will be returned.

parentinteger

Optional parent object ID. If provided, only child objects of given parent object will be returned, otherwise all top-level objects will be returned.

Response

Successful retrieval of objects.

aliasstring

Object alias

categoryinteger

Object category ID

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
guidstring uuid

Object GUID

idinteger

Object ID

isInMaintenanceModeboolean

true if object is in maintenance mode

isMaintenanceApplicableboolean

true if object can be placed into maintenance mode

namestring

Object name

timestampstring date-time

Object last change timestamp

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8