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 use a custom-brand, the URL is:
https://{partner_name}.api.vistanet.jpFor example, partner Alpha would use https://alpha.api.vistanet.jp.
Clients
For clients and partners who both use custom-brands in OpsRamp, the URL uses the client’s URL:
https://{client_name}.api.vistanet.jpIf partner Alpha and client Acme both are private-labeled, use https://acme.api.vistanet.jp.
For client uses custom-brand Acme and its partner is not custom-branded, use: https://api.vistanet.jp.
Header format
Each API request has the following header format:
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {accessToken} or Basic base64_encode(loginName:password) |