Endpoint
/api/v2/tenants/{tenantId}/integrations/installed/search
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

pageNo
integer

pageSize
integer

results
array

results.alertSource
Source of alert. Applicable only when installing category is Monitoring. Default Alert Source is taken as Custom.
results.category
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.
results.computeCredentials
Respose payload object
results.configFiles
results.containerEngineType
Specify container runtime engine either Docker, ContainerD, CRI-O
results.credentialSet
Name of credentialSets. Only used for compute Integration.
results.deployment
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.
results.description
results.direction
Direction of the installation. Applicable only when installing category is Collaboration. The default direction is taken as Inbound-Outbound.
results.displayName
Name used to identify the integration.
results.emailAddress
results.emailProps
results.id
results.inboundConfig
results.installedBy
results.installedTime
results.integration
results.ipAddress
ipAddress for the private cloud. To be only used for compute Integration.
results.logos
results.outboundConfig
results.parentIntg
results.status
results.ticketType
OpsRamp supports the following ticket types:
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "pageNo": 1,
  "pageSize": 5,
  "previousPageNo": 0,
  "results": [
    {
      "id": "INTG-10eb3495-d68e-d6d7-d177-0bfacf58d061",
      "inboundConfig": {
        "authentication": {
          "authType": "ALL"
        }
      },
      "integration": {
        "id": "RESTAPI",
        "name": "Custom"
      },
      "outboundConfig": {
        "baseNotifier": {
          "authType": "BASIC",
          "baseURI": "sp-config.in",
          "userName": "1234"
        }
      }
    },
    {
      "id": "INTG-15cd3139-00e3-4dbd-8aee-327e3d10e23e",
      "inboundConfig": {
        "authentication": {
          "authType": "WEBHOOK",
          "token": "bp78MehsKbdBgqezZXa2FKJvvXZPnMcC"
        },
        "mapAttributes": [
          {
            "attrName": "incident.status.name",
            "attrValues": [
              {
                "attrValue": "New",
                "thirdPartyAttrValue": "new"
              }
            ],
            "entityType": "INCIDENT",
            "name": "Status",
            "thirdPartyAttrName": "tren",
            "thirdPartyEntityType": "tree"
          }
        ]
      },
      "integration": {
        "id": "RESTAPI",
        "name": "Custom"
      },
      "outboundConfig": {
        "baseNotifier": {
          "authType": "BASIC",
          "baseURI": "sp-config.in",
          "userName": "1234"
        }
      }
    }
  ],
  "totalPages": 1,
  "totalResults": 2
}
{
  "descendingOrder": false,
  "nextPage": false,
  "pageNo": 1,
  "pageSize": 5,
  "previousPageNo": 0,
  "results": [
    {
      "id": "INTG-30afec31-9c37-4784-a6de-051997a5715e",
      "inboundConfig": {
        "authentication": {
          "authType": "WEBHOOK",
          "token": "w6bbEcYKnqggCkzPgBg745YXPKs3DuWb"
        },
        "mapAttributes": [
          {
            "attrName": "serviceRequest.status.name",
            "attrValues": [
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              },
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              }
            ],
            "entityType": "SERVICEREQUEST",
            "name": "Status",
            "thirdPartyAttrName": "Status",
            "thirdPartyEntityType": "SRQ"
          },
          {
            "attrName": "incident.status.name",
            "attrValues": [
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              },
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              }
            ],
            "entityType": "INCIDENT",
            "name": "Status",
            "thirdPartyAttrName": "Status",
            "thirdPartyEntityType": "TICKET"
          },
          {
            "attrName": "incident.priority.name",
            "attrValues": [
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              },
              {
                "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"
              },
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              }
            ],
            "entityType": "SERVICEREQUEST",
            "name": "Priority",
            "thirdPartyAttrName": "severity",
            "thirdPartyEntityType": "SRQ"
          }
        ]
      },
      "integration": {
        "id": "JIRA",
        "name": "JIRA"
      },
      "outboundConfig": {
        "mapAttributes": [
          {
            "attrName": "incident.status.name",
            "attrValues": [
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "close"
              }
            ],
            "entityType": "INCIDENT",
            "name": "Status",
            "thirdPartyAttrName": "state",
            "thirdPartyEntityType": "ticket"
          },
          {
            "attrName": "incident.priority.name",
            "attrValues": [
              {
                "attrValue": "Very Low",
                "thirdPartyAttrValue": "low"
              }
            ],
            "entityType": "INCIDENT",
            "name": "Priority",
            "thirdPartyAttrName": "priority",
            "thirdPartyEntityType": "ticket"
          }
        ]
      }
    },
    {
      "id": "INTG-91d0160f-ddd9-7b54-ecd3-581356e2d8de",
      "integration": {
        "id": "EMAILINCIDENTS",
        "name": "Email Requests"
      },
      "outboundConfig": {}
    },
    {
      "id": "INTG-ca260626-8352-7c1f-52a5-71d425439e75",
      "inboundConfig": {
        "authentication": {
          "authType": "ALL"
        },
        "mapAttributes": [
          {
            "attrName": "incident.status.name",
            "attrValues": [
              {
                "attrValue": "low",
                "thirdPartyAttrValue": "verylow"
              }
            ],
            "entityType": "INCIDENT",
            "name": "Status",
            "thirdPartyAttrName": "testin",
            "thirdPartyEntityType": "test"
          }
        ]
      },
      "integration": {
        "id": "SLACK",
        "name": "Slack"
      },
      "outboundConfig": {}
    }
  ],
  "totalPages": 1,
  "totalResults": 3
}