API Call for OverOps On-Prem Instances

The following doc can be referenced to understand how to make API calls to our OverOps infrastructure:

This model uses the convention as if a user attempts to make an API call to our SaaS environment.

For example:

curl --request GET \
     --url https://api.overops.com/api/v1/services \
     --header 'X-API-KEY: *******' \
     --header 'accept: */*'

This will make an API call to api.overops.com and obtain the services available for this user.

This will not work for users that are utilizing their own on-prem instance of OverOps.

In the example below, we will have backend.test.com as our on-prem instance of OverOps. We simply replace the address listed above with our own internal address of our on-prem instance.

curl --request GET \
     --url https://backend.test.com/api/v1/services \
     --header 'X-API-KEY: *******' \
     --header 'accept: */*'

One would similarly obtain their API key as obtaining it in any instance of OverOps. To generate the token, go to your Profile (click on your Name) → Account in the OverOps App.

1 Like