API overview

An overview of the OpsRamp REST APIs.

Leave Feedback

Introduction

A full set of REST APIs manage the OpsRamp platform. These APIs provide GET, CREATE, UPDATE, and DELETE endpoints that manage clients, resources, alerts, and alert escalation policies.

Authentication

OpsRamp APIs use OAuth 2.0 based authentication.

Partner and client URLs

Partner and client URLs are fully supported.

Partners

For partners who uses a custom-brand, the URL is:

https://{partner_name}.api.opsramp.com

For example, partner Alpha would use https://alpha.api.opsramp.com.

For all other partners, use:

https://api.opsramp.com

Clients

For clients and partners who both use custom-brands in OpsRamp, the URL uses the client’s URL:

https://{client_name}.api.opsramp.com

If partner Alpha and client Acme both are private-labeled, use https://acme.api.opsramp.com.

For client uses custom-brand Acme and its partner is not custom-branded, use: https://api.opsramp.com.

Header format

Each API request has the following header format:

HeaderValue
Acceptapplication/json
Content-Typeapplication/json
AuthorizationBearer {accessToken} or Basic base64_encode(loginName:password)