Install Email Request Integration

Installs an email request integration.

Email request integration creates tickets in platform via email. User needs to convert image to Base64 and enter the code in file field as shown in the following sample request.

Path Parameters

  • 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

  • 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...