Retrieve detailed information about all monitors.

GET 
/query/objects

Call this API to obtain comprehensive details about each monitor.

Request

Responses

200

The request was successful, and the server has returned the requested details about all monitors. The response contains a JSON object with comprehensive information on each monitor.

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

The server understood the request but refuses to authorize it. This can happen if the client does not have the necessary permissions 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

The server encountered an unexpected error that prevented it from fulfilling the request. This may be due to a server malfunction or a misconfiguration. The response contains details about the internal server error.

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...