API Overview

Describes all the essential properties which a user should know to optimal execution of API requests.

OpsRamp Public API's Base URL

The API fully supports domain-specific tenants (partner and client) URLs. The base URL for tenants who do not use custom branding is:

https://api.opsramp.com/api/

Custom or Privated branded URLs

Tenant with custom branding use a base URL that has the following format: https://{custom-branded-url}.api.opsramp.com/api

For example, custom-branded-url for the tenant with domain name, acme would be https://acme.api.opsramp.com/api

HTTP status codes

These status codes are returned by the APIs:

Rate limits

API throttling limits the number of requests an API server accepts within a given time period. API requests are throttled to ensure a better quality of service(QoS).

OpsRamp APIs Rate limits

The following limits apply for each tenant (service provider, partner, and client) as requests per minute: The following table shows partner-level and client-level rate limits for the different resource categories:

A request that is rejected because it exceeds the rate limit returns a HTTP 429 Too Many Requests status code with the following error information in the response body:

{
    "error" : "throttled",
    "error_description" : "Too Many Requests"
}

Once the rate limit is reached, any additional API requests will not be processed until the next reset time interval.

The API response header provides details about the API rate limit, including the current usage count, the remaining requests, and additional information such as:

• x-ratelimit-bucket: "API_HITS:854521_28776146-alerts_write"
• x-ratelimit-limit: "500"
• x-ratelimit-remaining: "497"
• x-ratelimit-reset: "1726568820"

Filtering and Pagination

Where applicable, you can use the following query string parameters to get filter results paginated on API execution.The query format and its parameters can be concatenated as exampled below.The "queryString" formulates all the input filtering parameters given by user. Multiple query parameters are seggregated by ":" and concatenated by "+"

Special Characters

There are special characters that can be used in a queryString:

• (+) represents the next field and must be URL-encoded.
• (:) represents equals. An example is key : value.
• Space characters must be URL-encoded.
• Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
• (,) indicates multiple values for a key. An example is alert states: CRITICAL,WARNING

Default Filtering

Based on the API endpoint functionality some of the query filters would be mandatory else by default, the query would give all the results. In case of incorrect query parameters,the endpoint results to default.

• queryString is optional query parameter for search endpoints.
• optional query parameters are never validated and ignored if incorrect.
• recommended to use only correct and valid query parameters with queryString.

https://api.opsramp.com/api/v2/tenants/clientId/sites/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:31+name:east-zone+parentId:30

https://api.opsramp.com/api/v2/tenants/clientId/sites/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=states:CRITICAL,WARNING

OpsRamp API Pagination with Query Strings