Install Email Request Integration

post

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
This field is only used for compute integration in the private cloud. When you assign a static IP address (for example, 192.168.64.6), the system uses that specific IP. However, if you specify the IP in any of the following formats, it represents a range of addresses: - 172.26.1.0/24 - 172.26.1.* - 172.26.1.0-172.26.1.255
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
This field is only used for compute integration in the private cloud. When you assign a static IP address (for example, 192.168.64.6), the system uses that specific IP. However, if you specify the IP in any of the following formats, it represents a range of addresses: - 172.26.1.0/24 - 172.26.1.* - 172.26.1.0-172.26.1.255
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

Response Samples

{
  "id": "INTG-02d467ee-41f2-4d1e-9c55-e8365b421f21",
  "displayName": "email incidents test",
  "integration": {
    "id": "EMAILINCIDENTS",
    "name": "Email Requests"
  },
  "emailAddress": "alerts@5JHqWy4h34xXDwN2gYFtmaYx.opsramp.com",
  "emailProps": [
    {
      "properties": [
        {
          "name": "Allow anonymous user",
          "value": "true"
        },
        {
          "name": "Subject",
          "value": "Email Subject"
        },
        {
          "name": "Description",
          "value": "Email Description"
        },
        {
          "name": "Priority",
          "defaultValue": "Low",
          "condition": {
            "contentSource": "EMAIL_CONTENT",
            "operator": "BETWEEN",
            "startValue": "value1",
            "endValue": "value2"
          },
          "propertyMappings": {
            "name": "Priority",
            "attrName": "incident.priority.name",
            "entityType": "INCIDENT",
            "attrValues": [
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "myval"
              }
            ]
          }
        }
      ]
    }
  ]
}

Path Parameters

Request Body

Responses

200OK

Response Samples