OpManager MSP REST API

  • OpManager MSP offers REST APIs for adding and fetching data from OpManager MSP. Using these APIs, you can integrate OpManager MSP with 3rd party IT management/service desk software.
  • How OpManager MSP REST APIs work?

    • The APIs work with an API key. The API key is unique for each OpManager MSP account and is mandatory for all API requests.
    • Only a limited number of APIs are authorized in the central system; for further information, please click here.
    • For external API requests in MSP Central, regionID & selCustomerID parameters are mandatory. To obtain the values for these APIs, click here. Note that, -1 can be passed as value for these parameters by default.

    How to view the API Key?

    To view or copy an API key, go to Quick links > Rest Api Key option in OpManager MSP web client (The quick link option is the Gear icon on the top right corner).

    How to send an apiKey?

    The functionality of request parameter-based apiKey authentication has been deprecated. Before version, 128100, the apiKey can be sent via the request parameter. From version 128100, the apiKey can now be sent either in the request header or as a request parameter.


    A Sample configuration with header: api_header

    Enable / Disable Rest API access

    From version 127185, the option to enable/disable Rest API has been added.

    What has changed?

    • Rest API access will be disabled by default for the new users created under User Management. An administrator with complete access to all the modules and devices will be able to edit the user under User Management and provide Rest API access if required.
    • enable-api-1

    • If the RestApikey access has been enabled for the users, Rest API menu under Quick links will display the RestApikey, and external Rest API calls will be allowed only if the Rest API access has been enabled for the user.
    • enable-api-2

    • If the Rest API access has been disabled, the Rest API menu under Quick links will display "Contact the administrator user".
    • enable-api-3

    What APIs are allowed in OpManager MSP's central server?

    The following table contains the list of APIs are allowed in OpManager MSP central server,
    API
    /api/json/alarm/listAlarms
    /api/json/v2/device/listDeviceDetails
    /api/json/businessview/getBusinessDetailsView
    /api/json/reports/getReportsList
    /api/json/admin/licenseDetails
    /api/json/reports/getReportsData
    /api/json/device/fetchMonitorsList
    /api/json/v2/device/getReportData
    /api/json/events/listEvents
    /api/json/admin/listAllLogicalGroups
    /api/json/admin/listLogicalGroupMembers
    /api/json/device/listInterfaces
    /api/json/admin/getOPMBasicDetails
    /api/json/admin/getDeviceMonitorsMapping
    /api/json/admin/getHistoricFiles
    /api/json/admin/listURLMonitors
    /api/json/admin/listAllDevicesSpecificURLs
    /api/json/admin/getHistoricFilesForPeriod
    /api/json/admin/listCustomerNames
    /api/json/tab/getTabViewDetails

    Note:

    TFA: If Two-Factor Authentication has been configured, TFA OTP validation is mandatory to enable Rest API access.

    Regenerate an API key:To generate an API key, go to Settings > Basic Settings > REST API in OpManager MSP web client and click on Regenerate Key.

Alarms

Availability

Business views

Dashboard

Devices

Discovery

Enterprise

Events

Groups

Interfaces

Monitoring

Notifications

MSP Central

Reports

Subnets

Wireless

Settings

Back to Top