Endpoint
/api/v2/tenants/{tenantId}/integrations/install/EMAILALERTS
Path Parameters
tenantIdstring
Describes the client ID or msp ID of the tenant
alertSourceobject
Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.
Child Parameters
- alertSource.displayName
- alertSource.id
- alertSource.name
- alertSource.techUid
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.
computeCredentialsobject
Respose payload object
Child Parameters
- computeCredentials.autoMonitorable
- computeCredentials.description
- VMware details description
- computeCredentials.id
- VmWare
- computeCredentials.name
- computeCredentials.port
- Port no
- computeCredentials.secure
- computeCredentials.uniqueId
- uuid
credentialSetstring
Name of credentialSets. Only used for compute Integration.
descriptionstring
directionstring
Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.
displayNamestring
Name used to identify the integration.
emailAddressstring
emailPropsarray
Child Parameters
- emailProps.identifier
- Unique value of a set.Email data identifies the set with this identifier and parses with the respective parsing conditions.
- emailProps.identifierSource
- Source for considering the unique value. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
- emailProps.name
- Name of parsing conditions set.
- emailProps.properties
idstring
inboundConfigobject
Child Parameters
- inboundConfig.authentication
- inboundConfig.discoveryProfile
- inboundConfig.dropAlerts
- Configure to drop alerts from UnManaged resources.
- inboundConfig.entityTypes
- Type of supported service desk entities (INCIDENT,CHANGE,SERVICEREQUEST,PROBLEM) using WEBHOOK only.
- inboundConfig.mapAttributes
- inboundConfig.webhookUris
installedBystring
installedTimestring
ipAddressstring
ipAddress for the private cloud. To be only used for compute Integration.
outboundConfigobject
Child Parameters
- outboundConfig.baseNotifier
- The fields are required unless specific to an `authType`.
- outboundConfig.mapAttributes
statusstring
ticketTypestring
OpsRamp supports the following ticket types:
{
"displayName": "Email Alerts Integration",
"emailProps": [
{
"identifier": "identify",
"identifierSource": "EMAIL_CONTENT",
"name": "test set 1",
"properties": [
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"defaultValue": "OK",
"name": "Alert State"
},
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"name": "Service Name"
},
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"name": "Device Host Name"
}
]
}
],
"inboundConfig": {
"dropAlerts": true
},
"logo": {
"file": "zWc/aG7Ws5nifQL0cHF6fxW8vRwcXp/Ffyky7HaICAgIXNbBkr5hzWwZK+YY9FmJ/FLppwpn45SvJ2S4oBaNgBAQEBAQEBAQEBAQEBAQEBAQf//Z ",
"name": "logo.png"
}
}
Responses
OK
alertSourceobject
Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.
Child Parameters
- alertSource.displayName
- alertSource.id
- alertSource.name
- alertSource.techUid
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.
computeCredentialsobject
Respose payload object
Child Parameters
- computeCredentials.autoMonitorable
- computeCredentials.description
- VMware details description
- computeCredentials.id
- VmWare
- computeCredentials.name
- computeCredentials.port
- Port no
- computeCredentials.secure
- computeCredentials.uniqueId
- uuid
credentialSetstring
Name of credentialSets. Only used for compute Integration.
descriptionstring
directionstring
Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.
displayNamestring
Name used to identify the integration.
emailAddressstring
emailPropsarray
Child Parameters
- emailProps.identifier
- Unique value of a set.Email data identifies the set with this identifier and parses with the respective parsing conditions.
- emailProps.identifierSource
- Source for considering the unique value. Supported Values: EMAIL_SUBJECT, EMAIL_CONTENT, DEFAULT_VALUE.
- emailProps.name
- Name of parsing conditions set.
- emailProps.properties
idstring
inboundConfigobject
Child Parameters
- inboundConfig.authentication
- inboundConfig.discoveryProfile
- inboundConfig.dropAlerts
- Configure to drop alerts from UnManaged resources.
- inboundConfig.entityTypes
- Type of supported service desk entities (INCIDENT,CHANGE,SERVICEREQUEST,PROBLEM) using WEBHOOK only.
- inboundConfig.mapAttributes
- inboundConfig.webhookUris
installedBystring
installedTimestring
ipAddressstring
ipAddress for the private cloud. To be only used for compute Integration.
outboundConfigobject
Child Parameters
- outboundConfig.baseNotifier
- The fields are required unless specific to an `authType`.
- outboundConfig.mapAttributes
statusstring
ticketTypestring
OpsRamp supports the following ticket types:
{
"displayName": "email alerts test from api try 44",
"emailAddress": "alerts@5JHqWy4h34xXDwN2gYFtmaYx.opsramp.com",
"emailProps": [
{
"identifier": ".",
"identifierSource": "EMAIL_CONTENT",
"name": "test set 1",
"properties": [
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"defaultValue": "OK",
"name": "Alert State"
},
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"name": "Service Name"
},
{
"condition": {
"contentSource": "EMAIL_CONTENT",
"endValue": "value2",
"operator": "BETWEEN",
"startValue": "value1"
},
"name": "Device Host Name"
}
]
}
],
"id": "INTG-d9b99937-7906-42c7-955c-68a237144ac7",
"inboundConfig": {
"dropAlerts": true
},
"integration": {
"id": "Email Alerts",
"name": "Email Alerts"
}
}