Retrieve Monitor Details by Filter

GET 
/query/objects/

Call this API to get the details of monitors based on specific filters. The filter parameter must be provided in the query to filter and retrieve monitors that match the specified criteria.

Request

Query Parameters

filter objectrequired

The filter is an object that contains key-value pairs to filter monitors by specific criteria. The key indicates what attribute to filter by (e.g. object type) and the value provides the acceptable values for that attribute.

Responses

200

Successful response. The request was successful, and the details of the monitors matching the specified filters were returned.

application/json

Schema

Schema

result object[]
Array [
id integer
object.target string
object.ip string
object.host string
object.name string
object.system.oid string
object.type string
object.discovery.method string
object.state string
object.category string
remote.address string
user.name string
object.creation.time string
object.creation.time.seconds integer
object.business.hour.profile integer
object.id integer
object.groups integer[]
object.snmp.device.catalog integer
object.make.model string
object.context object
ping.check.status string
port integer
snmp.check.retries integer
interface.discovery string
topology.plugin.discovery string
object.vendor string
]

Example (from schema)

{
  "result": [
    {
      "id": 48159328544,
      "object.target": "172.16.8.2",
      "object.ip": "172.16.8.2",
      "object.host": "cisco_core.motadata.local",
      "object.name": "cisco_core.motadata.local",
      "object.system.oid": ".1.3.6.1.4.1.9.1.2494",
      "object.type": "Switch",
      "object.discovery.method": "REMOTE",
      "object.state": "ENABLE",
      "object.category": "Network",
      "remote.address": "127.0.0.1",
      "user.name": "admin",
      "object.creation.time": "2024/07/11 15:21:18",
      "object.creation.time.seconds": 1720691478,
      "object.business.hour.profile": 10000000000001,
      "object.id": 10,
      "object.groups": [
        10000000000002
      ],
      "object.snmp.device.catalog": 10000000011869,
      "object.make.model": "Cisco Catalyst 93xx Switch Stack",
      "object.context": {
        "ping.check.status": "yes",
        "port": 161,
        "snmp.check.retries": 2,
        "interface.discovery": "yes",
        "topology.plugin.discovery": "yes"
      },
      "object.vendor": "Cisco Systems"
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

Request Forbidden. The request was forbidden. The client does not have permission to access this resource.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

Internal server error. An internal server error occurred while processing the request.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...