This page contains release notes for features and updates to the OpsRamp APIs.

April 2025

ADDED
Added support for Log Enrichment Lookup Tables and Configurations through the following APIs:
CHANGED
Before:

The /opsql/api/v3/tenants/{tenantId}/queries API does not have sortBy and sortByOrder in the request or response payloads.

After:

The /opsql/api/v3/tenants/{tenantId}/queries API now includes sortBy and sortByOrder in the request or response payloads. You can specify the field and sort direction when querying saved queries.

UPDATED

The documentation for below Exports APIs has been updated to include the required permission sets. You can now clearly understand what permissions are necessary to perform operations like exporting data or configuring exports.

UPDATED
Added a note in /api/v2/tenants/{clientId}/scheduleMaintenances/{smId} API to clarify usage of the offset in the startTime and endTime attributes in the POST request.
UPDATED
Updated the /api/v2/tenants/{tenantId}/integrations/install/{uniqueName} API to clarify the usage of the ipAddress field for compute integrations in private cloud environments.
This field can accept:
  • A static IP address (e.g., 192.168.64.6), which the system uses directly.
  • IP ranges using formats such as:
    • 172.26.1.0/24
    • 172.26.1.*
    • 172.26.1.0-172.26.1.255

February 2025

ADDED
Added support for Synthetics in /api/v3/tenants/{tenantId}/apps/install/{id}/config (Install app profiles) API.
ADDED
Added support for Synthetics in /api/v3/tenants/{tenantId}/apps/install/{id}/config/{id} (Manage app profiles) API (GET, POST, and DELETE).
ADDED
Added support for Synthetics as an integration in /api/v2/tenants/{tenantId}/integrations/install/{uniqueName} (Install Integrations) API.
ADDED
The /api/v2/tenants/{clientId}/resourceMonitors (Create Resource Monitors) V2 API now supports RSE Script payloads for request processing. With this enhancement you can define and execute custom monitoring logic using RSE scripts.
CHANGED
Before:

The /api/v2/tenants/{clientId}/resources/{resourceId} (Manage Resource - POST) API supported Synthetics as a resource type.

After:

The /api/v2/tenants/{clientId}/resources/{resourceId} (Manage Resource) no longer supports Synthetics. Users will no longer be able to manage resources related to Synthetics using this API. Any requests containing Synthetics-related attributes will result in 500 Internal Server Error.

CHANGED
Before:

The /api/v2/tenants/{clientId}/resources (Creates Resource) API supported Synthetics as a resource type.

After:

The /api/v2/tenants/{clientId}/resources (Creates Resource) no longer supports Synthetics. Users will no longer be able to create resources related to Synthetics using this API. Any requests containing Synthetics-related attributes will result in 500 Internal Server Error.
You can now install Synthetics as an integration using the /api/v2/tenants/{tenantId}/integrations/install/{uniqueName} (Install Integrations) API.

January 2025

ADDED
A new /graph/api/v3/tenants/{clientId}/topology/map/relationships (Get topology relationship data) V3 API has been released to access and sync the client-level relationship data with external systems.
CHANGED
Before:

The /opsql/api/v3/tenants/{tenantId}/queries (queries) API did not include the targetResource.id field in the request payload for example-query-resource-in-relationships example.

After:

The example-query-resource-in-relationships request payload now includes targetResource.id, allowing for more precise querying and relationship mapping.