Documentation is now available for the Fall 2020 Update release!

Search installed integrations

This endpoint is used to search for installed integrations.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/search

Sample URLs

https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:CUSTOM_INTEGRATION+uId:RESTAPI
https://{api-url}/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:ITSM_INTEGRATION

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}false
sortName={field}name
queryString={queryString}NA

NA indicates that the value is not applicable.

Categories

	ITSM_INTEGRATION
	MONITORING_INTEGRATION
	REMOTE_CONSOLE_INTEGRATION
	PASSWORD_MANAGEMENT_INTEGRATION
	CLOUD_INTEGRATION
	DEPLOYMENT_INTEGRATION
	OTHER_INTEGRATION
	COMING_SOON_INTEGRATION
	CUSTOM_INTEGRATION
	INTERNAL_INTEGRATION
	NETWORK_INTEGRATION
	STORAGE_INTEGRATION
	COMPUTE_INTEGRATION
	PATCH_MANAGEMENT_INTEGRATION
	SSO_INTEGRATION
	DATA_EXPORT_INTEGRATION
	AUTOMATION_INTEGRATION

Status code

200 OK

Search for a custom integration

Sample URL

https://api.opsramp.com/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:CUSTOM_INTEGRATION+uId:CUSTOM

Sample response

{
  "results": [
    {
      "id": "INTG-10eb3495-d68e-d6d7-d177-0bfacf58d061",
      "integration": {
        "id": "RESTAPI",
        "name": "Custom"
      },
      "inboundConfig": {
        "authentication": {
          "authType": "ALL"
        }
      },
      "outboundConfig": {
        "baseNotifier": {
          "baseURI": "sp-config.in",
          "authType": "BASIC",
          "userName": "1234"
        }
      }
    },
    {
      "id": "INTG-15cd3139-00e3-4dbd-8aee-327e3d10e23e",
      "integration": {
        "id": "RESTAPI",
        "name": "Custom"
      },
      "inboundConfig": {
        "authentication": {
          "authType": "WEBHOOK",
          "token": "bp78MehsKbdBgqezZXa2FKJvvXZPnMcC"
        },
        "mapAttributes": [
          {
            "name": "Status",
            "attrName": "incident.status.name",
            "thirdPartyAttrName": "tren",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "tree",
            "attrValues": [
              {
                "attrValue": "New",
                "thirdPartyAttrValue": "new"
              }
            ]
          }
        ]
      },
      "outboundConfig": {
        "baseNotifier": {
          "baseURI": "sp-config.in",
          "authType": "BASIC",
          "userName": "1234"
        }
      }
    }
  ],
  "totalResults": 2,
  "pageNo": 1,
  "pageSize": 5,
  "totalPages": 1,
  "nextPage": false,
  "previousPageNo": 0,
  "descendingOrder": false
}

Search for an ITSM integration

Sample URL

https://api.opsramp.com/api/v2/tenants/client_8/integrations/installed/search?pageNo=1&pageSize=10&queryString=category:ITSM_INTEGRATION

Sample response

{
  "results": [
    {
      "id": "INTG-30afec31-9c37-4784-a6de-051997a5715e",
      "integration": {
        "id": "JIRA",
        "name": "JIRA"
      },
      "inboundConfig": {
        "authentication": {
          "authType": "WEBHOOK",
          "token": "w6bbEcYKnqggCkzPgBg745YXPKs3DuWb"
        },
        "mapAttributes": [
          {
            "name": "Status",
            "attrName": "serviceRequest.status.name",
            "thirdPartyAttrName": "Status",
            "entityType": "SERVICEREQUEST",
            "thirdPartyEntityType": "SRQ",
            "attrValues": [
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              },
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              }
            ]
          },
          {
            "name": "Status",
            "attrName": "incident.status.name",
            "thirdPartyAttrName": "Status",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "TICKET",
            "attrValues": [
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              },
              {
                "attrValue": "Open",
                "thirdPartyAttrValue": "In Progress"
              },
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "Completed"
              }
            ]
          },
          {
            "name": "Priority",
            "attrName": "incident.priority.name",
            "thirdPartyAttrName": "severity",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "TICKET",
            "attrValues": [
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              },
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              }
            ]
          },
          {
            "name": "Priority",
            "attrName": "serviceRequest.priority.name",
            "thirdPartyAttrName": "severity",
            "entityType": "SERVICEREQUEST",
            "thirdPartyEntityType": "SRQ",
            "attrValues": [
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              },
              {
                "attrValue": "High",
                "thirdPartyAttrValue": "Max"
              },
              {
                "attrValue": "Low",
                "thirdPartyAttrValue": "min"
              }
            ]
          }
        ]
      },
      "outboundConfig": {
        "mapAttributes": [
          {
            "name": "Status",
            "attrName": "incident.status.name",
            "thirdPartyAttrName": "state",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "ticket",
            "attrValues": [
              {
                "attrValue": "Closed",
                "thirdPartyAttrValue": "close"
              }
            ]
          },
          {
            "name": "Priority",
            "attrName": "incident.priority.name",
            "thirdPartyAttrName": "priority",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "ticket",
            "attrValues": [
              {
                "attrValue": "Very Low",
                "thirdPartyAttrValue": "low"
              }
            ]
          }
        ]
      }
    },
    {
      "id": "INTG-91d0160f-ddd9-7b54-ecd3-581356e2d8de",
      "integration": {
        "id": "EMAILINCIDENTS",
        "name": "Email Requests"
      },
      "outboundConfig": {}
    },
    {
      "id": "INTG-ca260626-8352-7c1f-52a5-71d425439e75",
      "integration": {
        "id": "SLACK",
        "name": "Slack"
      },
      "inboundConfig": {
        "authentication": {
          "authType": "ALL"
        },
        "mapAttributes": [
          {
            "name": "Status",
            "attrName": "incident.status.name",
            "thirdPartyAttrName": "testin",
            "entityType": "INCIDENT",
            "thirdPartyEntityType": "test",
            "attrValues": [
              {
                "attrValue": "low",
                "thirdPartyAttrValue": "verylow"
              }
            ]
          }
        ]
      },
      "outboundConfig": {}
    }
  ],
  "totalResults": 3,
  "pageNo": 1,
  "pageSize": 5,
  "totalPages": 1,
  "nextPage": false,
  "previousPageNo": 0,
  "descendingOrder": false
}

Search for an ITSM integration - ServiceNow

Sample URL

https://api.opsramp.com/api/v2/tenants/client_3025/integrations/installed/search?queryString=category:ITSM_INTEGRATION%2BuId:SERVICENOW%2Bname:ServiceNow%2BuniqueId:INTG-0440705d-8963-41f3-a27f-c95af4bca2ad

Sample response

{
    "results": [
        {
            "id": "INTG-0440705d-8963-41f3-a27f-c95af4bca2ad",
            "integration": {
                "id": "SERVICENOW",
                "name": "ServiceNow"
            },
            "inboundConfig": {
                "authentication": {
                    "authType": "OAUTH2",
                    "apiKeyPairs": [
                        {
                            "key": "C6X55eaCkn93FUFg7m2nKQWDxSYF6tnW"
                        }
                    ]
                },
                "mapAttributes": [
                    {
                        "name": "Status",
                        "attrName": "serviceRequest.status.name",
                        "thirdPartyAttrName": "Status",
                        "entityType": "SERVICEREQUEST",
                        "thirdPartyEntityType": "SRQ",
                        "mode": "INBOUND",
                        "attrValues": [
                            {
                                "attrValue": "Open",
                                "thirdPartyAttrValue": "In Progress"
                            },
                            {
                                "attrValue": "Closed",
                                "thirdPartyAttrValue": "Completed"
                            }
                        ]
                    },
                    {
                        "name": "Status",
                        "attrName": "incident.status.name",
                        "thirdPartyAttrName": "Status",
                        "entityType": "INCIDENT",
                        "thirdPartyEntityType": "TICKET",
                        "mode": "INBOUND",
                        "attrValues": [
                            {
                                "attrValue": "Open",
                                "thirdPartyAttrValue": "In Progress"
                            },
                            {
                                "attrValue": "Closed",
                                "thirdPartyAttrValue": "Completed"
                            }
                        ]
                    },
                    {
                        "name": "Priority",
                        "attrName": "incident.priority.name",
                        "thirdPartyAttrName": "severity",
                        "entityType": "INCIDENT",
                        "thirdPartyEntityType": "TICKET",
                        "mode": "INBOUND",
                        "attrValues": [
                            {
                                "attrValue": "High",
                                "thirdPartyAttrValue": "Max"
                            },
                            {
                                "attrValue": "Low",
                                "thirdPartyAttrValue": "min"
                            }
                        ]
                    },
                    {
                        "name": "Priority",
                        "attrName": "serviceRequest.priority.name",
                        "thirdPartyAttrName": "severity",
                        "entityType": "SERVICEREQUEST",
                        "thirdPartyEntityType": "SRQ",
                        "mode": "INBOUND",
                        "attrValues": [
                            {
                                "attrValue": "High",
                                "thirdPartyAttrValue": "Max"
                            },
                            {
                                "attrValue": "Low",
                                "thirdPartyAttrValue": "min"
                            }
                        ]
                    }
                ]
            },
            "outboundConfig": {
                "baseNotifier": {
                    "baseURI": "https://kailash.opsramp.net",
                    "authType": "OAUTH2",
                    "grantType": "CLIENT_CREDENTIALS",
                    "apiKey": "nSYJ4GPWC63C7gXUDj7Wq5xdMQ9S4kbD",
                    "accessTokenURL": "https://kailash.opsramp.net/auth/oauth/token"
                },
                "mapAttributes": [
                    {
                        "name": "Status",
                        "attrName": "incident.status.name",
                        "thirdPartyAttrName": "status",
                        "entityType": "INCIDENT",
                        "thirdPartyEntityType": "Ticket",
                        "mode": "OUTBOUND",
                        "attrValues": [
                            {
                                "attrValue": "Open",
                                "thirdPartyAttrValue": "good"
                            },
                            {
                                "attrValue": "New",
                                "thirdPartyAttrValue": "Open"
                            }
                        ]
                    }
                ],
                "intgEvents": [
                    {
                        "id": "INTG-EVENT-757802c6-9ee3-423c-9a90-8c52bc2ba63f",
                        "name": "Create event",
                        "entity": "DEFAULT_RESOURCE",
                        "notifier": {
                            "baseURI": "www.google.com"
                        },
                        "thirdPartyEventType": "POST",
                        "headers": [
                            {
                                "key": "accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "eventPayload": "{\n\t\"classcode\" : \"$defaultresource.classCode\"\n}"
                    },
                    {
                        "id": "INTG-EVENT-2d5f12da-e564-41be-88b3-9a2022185883",
                        "name": "update event",
                        "entity": "DEFAULT_RESOURCE",
                        "notifier": {
                            "baseURI": "$baseURI/api/v2/tenants/client_86923/incidents"
                        },
                        "thirdPartyEventType": "POST",
                        "headers": [
                            {
                                "key": "accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "eventPayload": "{\n\t\"classcode\" : \"$defaultresource.classCode\"\n}",
                        "responseHeaders": [
                            {
                                "key": "extTicketId",
                                "value": "$id"
                            }
                        ]
                    },
                    {
                        "id": "INTG-EVENT-1b2aa095-29e0-4afb-9cb6-b6bf4f6d5a3e",
                        "name": "Create event",
                        "entity": "INCIDENT",
                        "notifier": {
                            "baseURI": "www.google.com"
                        },
                        "thirdPartyEventType": "POST",
                        "headers": [
                            {
                                "key": "accept",
                                "value": "application/json"
                            },
                            {
                                "key": "Content-Type",
                                "value": "application/json"
                            }
                        ],
                        "eventPayload": "{\n\t\"classcode\" : \"$incident.classCode\"\n}"
                    }
                ]
            }
        }
    ],
    "totalResults": 1,
    "pageNo": 1,
    "pageSize": 100,
    "totalPages": 1,
    "nextPage": false,
    "previousPageNo": 0,
    "descendingOrder": false
}