OpManager External APIs

A REST interface for integrating OpManager with third-party IT management and service desk software. Authenticate once, automate everything.

BASE URL

http://localhost:8060

AUTH

apikey header

FORMAT

JSON

SPEC

OpenAPI 3.1.0 • API v1.0

Download OpenAPI Spec (JSON)

Make your first request

Every request requires an API key, sent in the apikey header. Keys are unique per OpManager user account.

Enable REST API access

REST API access is disabled by default. An admin can enable it under Settings > User Management by editing the user.

Get your API key

Open the OpManager web client, click the Gear icon in the top-right, then Quick Links → REST API Key. To regenerate a key, go to Settings > Basic Settings > REST API and click Regenerate Key.

Set the apikey header

Attach it to every request. Treat the key like a password — never commit it to source control.

Call any endpoint

All endpoints return JSON. Browse the OpenAPI spec for the full list of available operations.

Request Example

curl -X GET "http://localhost:8060/api/json/device/listDevices" \
  -H "apikey: <your-api-key>"

const res = await fetch(
  "http://localhost:8060/api/json/device/listDevices",
  { headers: { "apikey": "<your-api-key>" } }
);
const data = await res.json();

import requests

res = requests.get(
    "http://localhost:8060/api/json/device/listDevices",
    headers={"apikey": "<your-api-key>"},
)

devices = res.json()

Sample Response

200OK

{
  "devices": [
    {
      "id": "10241",
      "name": "core-switch-01",
      "type": "Switch",
      "status": "Up"
    }
  ]
}

Rate Limiting

API endpoints enforce rate limits to protect server performance. Limits vary by endpoint — typically 500 requests per minute for read operations and 100 requests per minute for write/configuration operations. When the limit is exceeded, the API returns HTTP 429 Too Many Requests. The rate limit for each endpoint is shown in its documentation below.

HTTP Methods

OpManager APIs use the following HTTP methods:

MethodPurpose

GETRetrieve data

POSTAdd or create data and perform actions

HTTP Status Codes

OpManager APIs return standard HTTP status codes to indicate success or failure:

Code	Status	Description
200	OK	Request succeeded. Response body contains the requested data.
400	Bad Request	Invalid or missing request parameters.
401	Unauthorized	Missing or invalid API key.
403	Forbidden	The API key does not have permission for this operation.
404	Not Found	The requested resource or endpoint does not exist.
429	Too Many Requests	Rate limit exceeded. Wait before retrying.
500	Internal Server Error	Unexpected server-side error. Contact your administrator if this persists.

Response Format

All responses are returned in JSON. Successful operations typically return the requested data directly or wrapped in a result object:

Success response

{
    "result": {
        "message": "Operation completed successfully"
    }
}

Error response

{
    "error": {
        "code": 400,
        "message": "Invalid parameter value"
    }
}

Pagination

List endpoints that return large datasets (e.g., listDevices v2) support pagination via page and rows query parameters. The response includes total, page, and records fields to help you iterate through results:

API Versioning

Some endpoints have multiple versions (e.g., /api/json/admin/listDevices and /api/json/v2/device/listDevices). Version 2 (v2) endpoints provide enhanced response formats, additional filtering, and pagination support. Use v2 endpoints where available for the best experience.

Example — Paginated request

GET /api/json/v2/device/listDevices?page=1&rows=200

Enterprise Edition (Central & Probe)

In OpManager Enterprise Edition, the Central server manages multiple Probes. Several API parameters are specific to this architecture:

eeProbeID — Probe ID, required when querying a specific probe from Central.
probeName — Name of the probe (from listProbes API response).

These parameters can be ignored when using OpManager Standard or Professional editions.

MSP Edition

In OpManager MSP Edition, the Central server manages multiple customers and regions. The following API parameters are specific to MSP deployments:

selCustomerID — Customer ID to scope requests to a specific customer. Set as -1 when fetching data from Central.
regionID — Region ID of the probe to scope requests to a specific region. Set as -1 when fetching data from Central.

These parameters can be ignored when using OpManager Standard, Professional, or Enterprise editions.