Getting Started


Introduction

Follow these steps to configure your OpsRamp account to call OpsRamp APIs.

Step 1: Install an integration

  • In the UI, go to: Setup > Integrations > Integrations.

  • Select Available Integrations > Other > Custom Integration.

  • Select Install.

  • Note down the Key, Secret, API Endpoint from your integration (see examples). You will use these to call APIs:

    • Key: x2AqYp2Ym4Wm2EgjWb2X28Estwn2hE58
    • Secret: aw6Prm4mk5K5AFmuWfqbyqxcnRMmBnaDV74PvT4sDanb8h3yq9fgEXcGjzbKFrzv
    • API Endpoint: https://api.opsramp.com
  • Select Save

Step 2: Get an OAuth 2.0 access token

Call the authentication API, using your Key, Secret, and API Endpoint, to get your access token (see example below).

Note:

  • Use your Key as the OAuth client_id and Secret as the client_secret.
  • Use your the OAuth client_credentials grant type.
curl https://api.opsramp.com/auth/oauth/token \
  -X POST \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "grant_type=client_credentials&client_id=M7X9sn7xBpCUsdNAFG7P5UxUjvhJm7Xv&client_secret=UPZPQJVhez6H8cC6kMPzKEmHR7k2ppGPRD8F7d42nvbVYCg9CFqtDGXMUtTUwC7y"

If your API call is successful, you should see a response like the example below:

{
   "access_token":"7ae76891-afa1-4d11-aa49-33367238e731",
   "token_type":"bearer",
   "expires_in":7199,
   "scope":"global:manage"
}

Note down the access token (access_token). You will use this call APIs.

Step 3: Note down your Tenant ID

In the UI, go to Setup > Accounts and note down your Tenant ID. Your Tenant ID is a unique identifier of your OpsRamp account and has one of these formats:

  • 5878ee58-8c5b-46a8-b975-3754c3c67977
  • msp_1234.

Step 4: Call an API

Call an API, using your Access Token and Tenant ID to validate that they work (see example):

curl https://api.opsramp.com/api/v2/tenants/msp_1234/resources/search \
    -X GET \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Authorization: bearer 7ae76891-afa1-4d11-aa49-33367238e731"
2021-010-14T05:35:07.322Z