Objects
Search objects
Search for objects matching certain criteria. Multiple criterias will be combined with logical AND.
post/v1/objects/search
Request body
classObjectClass[]
ipAddressstring ip-address
IP address filter string. If provided, only objects with matching primary IP address will be returned.
namestring
Name filter string. If provided, only objects with name or alias containing given string will be returned.
parentinteger
Parent object ID. If provided, only child objects (both direct and indirect) of given parent object will be returned.
zoneUINinteger
Zone UIN. If provided, only objects within given zone 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