In this section

Activate integration event

Activates an integration event.

Create integration event

Creates an integration event.

Events are used for sending certain notifications whenever an action is performed on OpsRamp entities.

Notes
  • Provide API payload in Base64 encoding.
  • Integration event for Alert entity is created only using API but can be viewed from the OpsRamp Portal.

Create Event with Alert Entity Type to create an event with alert entity type for work flow events only.

Deactivate integration event

Deactivates an integration event.

Disable integration

Disables an installed integration, temporarily disabling the integration services.

Enable installed integration

Enables an installed integration.

Get and update discovery profiles

Creates and updates AWS, Azure, and Google discovery profiles and gets a list of discovery profiles.

To fetch supported cloud resource types (AWS, Azure, and Google) during discovery, use the {api-url}/api/v2/tenants/{tenantId}/resourceTypes/{cloudType} endpoint.

Get configurable email properties

Gets the email properties of an entity.

Get installed integration events

Gets installed integration events.

Get integration activity

Gets the installation activity details of an installed integration activity.

Get integration event placeholders

Gets the integration event placeholders of an entity.

Supported entities are:

  • Incident
  • Change Request
  • Service Request
  • Problem
  • Task

Get integration mappable properties

Gets the integration mappable properties for an entity.

Install AWS integrations

These endpoint IDs are used to install third-party integrations.

The following cloud integrations are supported:

  • AWS
  • AZURE
  • GOOGLE
  • KUBERNETES

These are not supported for deployment, email requests, and other category integrations.

Install Azure integration

These endpoint IDs are used to install third-party integrations.

The following cloud integrations are supported:

  • AWS
  • AZURE
  • GOOGLE

These are not supported for deployment, email requests, and other category integrations.

Install custom integration

Installs a custom integration.

Install email alert integration

Installs email alert integrations. OpsRamp processes all incoming Alert emails.

Apply user-defined rules to create, acknowledge, and close alerts incoming emails.

Convert image to Base64 and enter the code in file field as shown in the following sample request.

Install email request integration

Installs an email request integration.

Email request integration creates tickets in OpsRamp via email.

Convert image to Base64 and enter the code in file field as shown in the following sample request.

Install Google integration

These endpoint IDs are used to install third-party integrations.

The following cloud integrations are supported:

  • AWS
  • AZURE
  • GOOGLE

These are not supported for deployment, email requests, and other category integrations.

Install integrations

Installs the following integrations:

  • cloud
  • monitoring
  • collaboration

To install the integration, provide the integration ID in {intgld}.'

Install SSO integration

Installs a SSO integration.

Install VMWARE integration

These endpoint IDs are used to install compute integrations

The following compute integrations are supported:

  • VMWARE These are only for private cloud discovery configurations

Manage cloud discovery profile

Gets and delete discovery profiles for AWS, Azure, and Google.

Manage inbound authentication

Creates and updates installed integration inbound authentication.

Manage installed integration

Updates, gets, and deletes the installed integration details.

Manage installed integration base notifier

Creates and updates an installed integration base notifier.

Manage installed integration mapping attributes

Creates, updates, and gets installed integration mapping attributes.

This attribute mapping is not applicable for email integrations.

Manage integration event

Updates, gets, and deletes an integration event.

Rescan discovery profiles

Rescans an AWS, Azure, and Google discovery profile.

Search available integrations

Searches available integrations.

Search cloud discovery profiles

Uses a discovery profile name to search for an AWS, Azure, and Google discovery profile.

Search installed integrations

Searches for installed integrations.

Notes

There are special characters that can be used in a query string:

  • (+) represents the next field and must be URL-encoded.
  • (:) represents equals. An example is key : value.
  • Space characters must be URL-encoded.