Install Integrations

To install the integration, provide the integration id in the available list. Find the list using endpoint /integrations/available/search

Installs the following integrations:

  • cloud : Required payload as in example.
  • Saas Applications : Required payload as in example.
  • monitoring : Default configuration needs no payload.
  • collaboration : Default configuration needs no payload.
  • exports :
    • In Exports for Webhook configuration, use WEBHOOKRECEIVER as uniqueName at partner scope only. eg <server_url>/api/v2/tenants/<partnerId>/integrations/install/WEBHOOKRECEIVER
    • All other batch export Integrations are supported at "partner scope" only.

Install the supported integrations by name

Path Parameters

  • uniqueNamestringrequired

    Describes the integration name in the available list of integrations

    Enum:
    NimsoftOMSPingdomStackdriverZabbixDynatraceSplunkPrometheusSite24X7ElasticLogAWSAzureGoogleAutotaskConnectWiseFreshserviceJIRAServiceNowSlackZendeskAlibabaAWSGoogleKubernetesVMWARESolarwindsOrionALERTLOGICAUTOTASKBMCREMEDYCHERWELLDATADOGDYNATRACEOPSMANAGERLOGZ_IOMESERVICEDESKPLUSNEWRELICPRISMAPUBLICCLOUDSLACKSTACKDRIVERSYSDIGSUMOLOGICSCOMZOOMOFFICE365WEBHOOKRECEIVERcitrixcvdavelocloudsnmpwmisshAWSS3AZUREEXPORTEVENTBRIDGE
  • tenantIdstringrequired

    Describes the tenantId of the tenant

Request Body

application/json

  • displayNamestring

    Name used to identify the integration.

  • integrationobject

  • ipAddressstring

    ipAddress for the private cloud. To be only used for compute Integration.

  • credentialSetstring

    Name of credentialSets. Only used for compute Integration.

  • credentialobject

    Credential details of cloud/saas-apps

  • logosobject

  • categorystring

    Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.

    Enum:
    CustomCollaborationMonitoringSSOAutomationADAPTER_INTEGRATIONREPORTING_APPS
  • installedBystring

  • installedTimestring

  • statusstring

  • alertSourceobject

    Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.

  • directionstring

    Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.

    Enum:
    InboundOutboundInbound-Outbound
  • descriptionstring

  • singleSignOnAuthenticationobject

  • discoveryProfilesarray

    Discovery profile configurations for Cloud and Cloud native resources.

  • inboundConfigobject

  • outboundConfigobject

  • emailPropsarray

  • configDetailsobject

    Export Integration details

  • emailAddressstring

  • ticketTypestring

    OpsRamp supports the following ticket types:

    Enum:
    INCIDENTSERVICEREQUESTCHANGE
  • parentIntgobject

  • deploymentstring

    Specify the k8s deployment environment where k8s cluster is onprem cluster or deployed using cloud provider. **Applicable to prometheus integration** : Optional to specify the deployment environment where the Prometheus agent will be installed.

    Enum:
    cloudonPremVM_UbuntuVM_Redhat

    Default: onPrem

  • containerEngineTypestring

    Specify container runtime engine either Docker, ContainerD, CRI-O

    Enum:
    DockerContainerDCRI-O

    Default: Docker

  • configFilesarray

  • profileobject

Loading Examples...

Responses

  • idstring

  • displayNamestring

    Name used to identify the integration.

  • integrationobject

  • ipAddressstring

    ipAddress for the private cloud. To be only used for compute Integration.

  • credentialSetstring

    Name of credentialSets. Only used for compute Integration.

  • computeCredentialsobject

    vmware details

  • credential

  • logosobject

  • categorystring

    Category describes the behavior of custom integration. Applicable only for Custom Integration installation. Example: If monitoring is selected as category, the integration will work as monitoring integration.

    Enum:
    CustomCollaborationMonitoringSSOAutomationADAPTER_INTEGRATIONREPORTING_APPSDATA_EXPORT_INTEGRATION
  • installedBystring

  • installedTimestring

  • statusstring

  • alertSourceobject

    Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.

  • directionstring

    Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.

    Enum:
    InboundOutboundInbound-Outbound
  • descriptionstring

  • singleSignOnAuthenticationobject

  • discoveryProfilesarray

    Discovery profile configurations for Cloud and Cloud native resources.

  • inboundConfigobject

  • outboundConfigobject

  • emailPropsarray

  • emailAddressstring

  • ticketTypestring

    OpsRamp supports the following ticket types:

    Enum:
    INCIDENTSERVICEREQUESTCHANGE
  • parentIntgobject

  • deploymentstring

    Specify the k8s deployment environment where k8s cluster is onprem cluster or deployed using cloud provider. **Applicable to prometheus integration** : Optional to specify the deployment environment where the Prometheus agent will be installed.

    Enum:
    cloudonPremVM_UbuntuVM_Redhat

    Default: onPrem

  • containerEngineTypestring

    Specify container runtime engine either Docker, ContainerD, CRI-O

    Enum:
    DockerContainerDCRI-O

    Default: Docker

  • configFilesarray

Loading Examples...