Create OpsRamp credentials
- In OpsRamp, open Setup > Integrations > Integrations.
- Under Available Integrations, select Other > Custom Integration and install it.
- Assign a role with the permissions your workflows need. Use a dedicated integration and the smallest appropriate role. Creating tickets, changing monitoring, executing jobs, and installing patches need different permissions.
- Copy the integration’s Key, Secret, and API Endpoint. Use the API endpoint, rather than the browser login URL or a gateway address.
- Find the target client’s Tenant ID under Setup > Accounts. OpsRamp documents UUIDs and identifiers such as
client_1234andmsp_1234.
Connect to Serval
Select OpsRamp when adding an integration to your workspace, then enter:
Serval exchanges the credentials for short-lived access tokens. You do not need to copy or periodically replace an access token. Catalyst help is available in the connection form.
Each connection targets one API host and tenant in request URLs. With partner credentials, create a separate connection for each client you intend to manage; the client’s identifier belongs in Tenant ID. Partner-level endpoints require the partner’s own identifier and appropriate permissions. OpsRamp also checks resource and client identifiers in filters and request bodies against your credential’s permissions.
To rotate credentials, reconnect and replace the Key and Secret together. Leaving an existing masked Secret unchanged preserves it. To change the API host or Tenant ID, create a new connection.
Check the connection
The connection check reads one page of resources. Three health workflows check resource, alert, and incident-ticket reads separately. An empty successful response is valid. Passing a read check does not establish write permissions or prove that an automation or patch operation will succeed.Work with the API
Use the OpsRamp v2 reference for each operation’s required fields and permissions. Ticket entity names are case-sensitive, and custom forms, required fields, statuses, and assignment identifiers vary by tenant. Read those settings before building a create or update request.
Use the operation’s path template with unencoded values in
pathParams. Each value must identify one path segment; separators, encoded route fragments, and . or .. are rejected. Put search filters in query instead of embedding them in the path.
Searches and pagination
Each API request returns one response, including its pagination fields. FollownextPage, nextPageNo, or the endpoint’s documented continuation fields to retrieve additional pages. The integration does not fetch them automatically.
OpsRamp’s queryString combines filters with +. Supply the unencoded value to the action; the request layer encodes query values. Invalid optional filters can be ignored by OpsRamp, so inspect the returned identifiers before using search results in a write operation. Resource searches default to managed resources, and ticket searches without a creation-date range default to the last 30 days. An empty search does not establish that older or unmanaged records are absent. See API Overview, Search Resources, and Search Tickets.
Retries and asynchronous operations
OpsRamp applies limits per tenant and API category. Reduce concurrency when you receive HTTP 429 and consult the provider’s rate-limit response headers. An accepted automation or patch request is not completion: use the corresponding status operation before reporting success. The integration does not automatically retry API operations. Some OpsRampGET requests execute actions, so the HTTP method alone does not establish that a retry is safe. After a timeout or ambiguous write failure, inspect the operation’s status before retrying. An expired-token response clears the cached token for the next request without replaying the failed operation.