Sign in
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' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | '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

isMaintenanceScheduledboolean

true if object has pending scheduled maintenance

namestring

Object name

timestampstring date-time

Object last change timestamp

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

Changes

Changed in 9 of the 115 revisions of this API.368

  • 2827204d68d911See the full diff
    • ●

      added the new Room enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new Room enum value to the request property /

      request-property-enum-value-added

  • c4fbee63f84333See the full diff
    • ●

      added the new CoolingZone enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new Facility enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PowerDomain enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new CoolingZone enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new Facility enum value to the request property /

      request-property-enum-value-added

    • ○

      added the new PowerDomain enum value to the request property /

      request-property-enum-value-added

  • 04731b73e7231See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 070b10a450e21See the full diff
    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed

  • 595d081990401See the full diff
    • ▲

      the // response's property type changed from string to integer for status

      response-property-type-changed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 47655614e52c1See the full diff
    • ▲

      the // response's property type changed from integer to string for status

      response-property-type-changed

  • fa1d1baee4021See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 021382e189552See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • c6aaf3632e482See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog