Endpoint
/api/v2/tenants/{tenantId}/integrations/install/{intgId}
Path Parameters
tenantId
string

intgId
string

alertSource
object

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

alertSource.displayName
alertSource.id
alertSource.name
alertSource.techUid
category
string

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.

computeCredentials
object

Respose payload object

computeCredentials.autoMonitorable
computeCredentials.description
VMware details description
computeCredentials.id
VmWare
computeCredentials.name
computeCredentials.port
Port no
computeCredentials.secure
computeCredentials.uniqueId
uuid
credentialSet
string

Name of credentialSets. Only used for compute Integration.

description
string

direction
string

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

displayName
string

Name used to identify the integration.

emailAddress
string

emailProps
array

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
id
string

inboundConfig
object

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
installedBy
string

installedTime
string

integration
object

integration.id
integration.multipleInstallations
integration.name
ipAddress
string

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

logos
object

logos.file
Base64 code file of the logo.
logos.name
outboundConfig
object

outboundConfig.baseNotifier
The fields are required unless specific to an `authType`.
outboundConfig.mapAttributes
parentIntg
object

parentIntg.id
status
string

ticketType
string

OpsRamp supports the following ticket types:

{
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK"
    }
  }
}
{
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK"
    },
    "mapAttributes": [
      {
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "SRQ"
      },
      {
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "SRQ"
      }
    ]
  }
}
{
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK"
    },
    "mapAttributes": [
      {
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "SRQ"
      },
      {
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "SRQ"
      }
    ]
  },
  "outboundConfig": {
    "baseNotifier": {
      "accessTokenURL": "www.token.com/cred",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "apiSecret": "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje",
      "authType": "OAUTH2",
      "baseURI": "www.google.com",
      "grantType": "PASSWORD",
      "password": "pk",
      "type": "REST_API",
      "userName": "testUser"
    },
    "mapAttributes": [
      {
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      }
    ]
  }
}
{
  "outboundConfig": {
    "baseNotifier": {
      "accessTokenURI": "www.token.com/cred",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "apiSecret": "asdfgnasinfpaiwerpfawpeojporwjaeprfwpejprwje",
      "authType": "OAUTH2",
      "baseURI": "www.google.com",
      "grantType": "PASSWORD",
      "password": "pk",
      "type": "REST_API",
      "userName": "testUser"
    },
    "mapAttributes": [
      {
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      }
    ]
  }
}
{
  "displayName": "Test Integration",
  "logo": {
    "file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUSExMVFhUVGBcXFhcYGBgaFxgVFRUYFxcYFRcYHSggHh8lGxsXIjEiJSkrLi4wFx8zODMtOCgtLisBCgoKDg0OGxAQGy0lICYtLS0tLy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIAHABwwMBEQACEQEDEQH/xAAcAAEAAgIDAQAAAAAp8j1D+zC/vI1R5usr1w5LeIXrhyW8RLd0GZTzYzPDR9FmJ/EcB5FdNOFM/FLppwpn45SvJ2S4oBaNgF9p2uPeSu3HirSPww7seKuOPwwzFo0EBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQf//Z",
    "name": "test.png"
  }
}
{
  "displayName": "Logix Integration",
  "parentIntg": {
    "id": "INTG-f3e44188-83d9-4efc-82d1-68b07b740f0b"
  }
}

Responses

OK

alertSource
object

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

alertSource.displayName
alertSource.id
alertSource.name
alertSource.techUid
category
string

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.

computeCredentials
object

Respose payload object

computeCredentials.autoMonitorable
computeCredentials.description
VMware details description
computeCredentials.id
VmWare
computeCredentials.name
computeCredentials.port
Port no
computeCredentials.secure
computeCredentials.uniqueId
uuid
credentialSet
string

Name of credentialSets. Only used for compute Integration.

description
string

direction
string

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

displayName
string

Name used to identify the integration.

emailAddress
string

emailProps
array

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
id
string

inboundConfig
object

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
installedBy
string

installedTime
string

integration
object

integration.id
integration.multipleInstallations
integration.name
ipAddress
string

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

logos
object

logos.file
Base64 code file of the logo.
logos.name
outboundConfig
object

outboundConfig.baseNotifier
The fields are required unless specific to an `authType`.
outboundConfig.mapAttributes
parentIntg
object

parentIntg.id
status
string

ticketType
string

OpsRamp supports the following ticket types:

{
  "id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK",
      "token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
    }
  },
  "integration": {
    "id": "CASERVICEDESK",
    "name": "Service Desk"
  }
}
{
  "id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK",
      "token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
    },
    "mapAttributes": [
      {
        "attrName": "serviceRequest.status.name",
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "SRQ"
      },
      {
        "attrName": "incident.status.name",
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          },
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      },
      {
        "attrName": "incident.priority.name",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrName": "serviceRequest.priority.name",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "SRQ"
      }
    ]
  },
  "integration": {
    "id": "CASERVICEDESK",
    "name": "Service Desk"
  }
}
{
  "id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK",
      "token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
    },
    "mapAttributes": [
      {
        "attrName": "serviceRequest.status.name",
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Status",
        "thirdPartyAttrName": "Status",
        "thirdPartyEntityType": "SRQ"
      },
      {
        "attrName": "incident.status.name",
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          },
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      },
      {
        "attrName": "incident.priority.name",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "TICKET"
      },
      {
        "attrName": "serviceRequest.priority.name",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ],
        "entityType": "SERVICEREQUEST",
        "name": "Priority",
        "thirdPartyAttrName": "severity",
        "thirdPartyEntityType": "SRQ"
      }
    ]
  },
  "integration": {
    "id": "CASERVICEDESK",
    "name": "Service Desk"
  },
  "outboundConfig": {
    "baseNotifier": {
      "accessTokenURL": "www.token.com/cred",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "authType": "OAUTH2",
      "baseURI": "www.google.com",
      "grantType": "PASSWORD",
      "userName": "testUser"
    },
    "mapAttributes": [
      {
        "attrName": "incident.status.name",
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          },
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      }
    ]
  }
}
{
  "id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  "integration": {
    "id": "CASERVICEDESK",
    "name": "Service Desk"
  },
  "outboundConfig": {
    "baseNotifier": {
      "accessTokenURL": "www.token.com/cred",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "authType": "OAUTH2",
      "baseURI": "www.google.com",
      "grantType": "PASSWORD",
      "userName": "testUser"
    },
    "mapAttributes": [
      {
        "attrName": "incident.status.name",
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          },
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          }
        ],
        "entityType": "INCIDENT",
        "name": "Status",
        "thirdPartyAttrName": "stats",
        "thirdPartyEntityType": "Ticket"
      }
    ]
  }
}
{
  "displayName": "Test Integration",
  "id": "INTG-b95d0d73-e904-4059-915c-7380396af61c",
  "integration": {
    "id": "CUSTOM",
    "name": "Custom"
  }
}
{
  "displayName": "Logix Integration",
  "id": "INTG-d4c2a1b3-0520-4e24-809f-b1a2857b88ac",
  "integration": {
    "id": "CUSTOM",
    "name": "Custom"
  }
}
{
  "id": "INTG-74640545-0895-4924-9261-250ce5ce7ad5",
  "integration": {
    "id": "PINGDOM",
    "name": "Pingdom"
  }
}