URL

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

Headers

  • Authorization: Bearer {accessToken}
  • Content-Type: application/json
  • Accept: application/json

Status code

200 OK

Sample URLs

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761

Parameters

FieldSubfieldsData TypeDescription
inboundConfigauthentication : authTypeStringAuthentication type: WEBHOOK, OAUTH2
Example: OAUTH2
inboundConfigmapAttributes: nameStringOpsRamp attribute name. Maps third-party attributes with OpsRamp attributes. Example: Priority
inboundConfigmapAttributes: tenantAttrNameStringThird-party attribute name. Maps third-party attributes with OpsRamp attributes. Example: Severity
inboundConfigmapAttributes: entityTypeStringOpsRamp Entity type. Maps third-party attributes with OpsRamp attributes. Values: ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK
Example: INCIDENT
inboundConfigmapAttributes: tenantEntityTypeStringThird-party entity type. Maps third-party attributes with OpsRamp attributes. Example: Ticket
inboundConfigmapAttributes: attrValues : attrValueStringOpsRamp attribute value. Maps OpsRamp attributes with third-party attributes. Examples: Open or In Progress
inboundConfigmapAttributes: attrValues: tenantAttrValueStringTenant attribute value. Maps third-party attributes with OpsRamp attributes. Examples: Open or In Progress
inboundConfigdropAlertsOnUnmanagedResourcesBoolean(Optional) When enabled, this parameter discards alerts from resources that are unmanaged. Applicable only for monitoring integration updates and custom integration updates when installed category is Monitoring. Options: true/false. Default: false
outboundConfigmapAttributes : nameStringOpsRamp attribute name. Maps third-party attributes with OpsRamp attributes. Example: Priority
outboundConfigmapAttributes : tenantAttrNameStringThird-party attribute name. Maps third-party attributes with OpsRamp attributes. Example: Severity
outboundConfigmapAttributes : entityTypeStringOpsRamp Entity type. Maps third-party attributes with OpsRamp attributes. Values: ALERT, PROBLEM, INCIDENT, CHANGE, SERVICEREQUEST, TASK
Example: INCIDENT
outboundConfigmapAttributes : tenantEntityTypeStringThird-party entity type. Maps third-party attributes with OpsRamp attributes. Example: Ticket
outboundConfigmapAttributes: attrValues : attrValueStringOpsRamp attribute value. Maps OpsRamp attributes with third-party attributes. Examples: Open or In Progress
outboundConfigmapAttributes: attrValues: tenantAttrValueStringTenant attribute value. Maps third-party attributes with OpsRamp attributes. Examples: Open or In Progress
outboundConfignotifier: typeStringNotifier types: SOAP_API, REST_API.Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes. Example: REST_API
outboundConfignotifier: authTypeStringAuthentication types: NONE, OAUTH2. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes. Example: OAUTH2
outboundConfignotifier: grantTypeStringGrant types: CLIENT_CREDENTIALS, PASSWORD_CREDENTIALS, REFRESH_TOKEN. Valid only if authentication type is OAUTH2. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes. Example: CLIENT_CREDENTIALS
outboundConfignotifier: userNameStringProvide user credentials of the person sending the notifier. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.
outboundConfignotifier: passwordStringProvide password of the user account. Valid only when authentication type is OAUTH2 and grant type is PASSWORD_CREDENTIALS/REFRESH_TOKEN. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.
outboundConfignotifier: apiKeyStringAPI key. Valid only if authentication type is OAUTH2. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.
outboundConfignotifier: apiSecretStringAPI secret. Valid only if authentication type is OAUTH2. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.
outboundConfignotifier: accessTokenURIStringURI used to get the access token. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.
outboundConfignotifier: alertSourceString(Optional) Source of alert. Applicable to Email Alert and Custom Integration Updates for Monitoring Integration category. View Alert Technologies API to know about the list of allowed Alert Sources. Notify events generated in OpsRamp to third-party entities. Notifications are sent with the attributes.

Sample 1 - Update integration

https://api.opsramp.com/api/v2/tenants/client_8/integrations/installed/INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761

Sample request

{
	"inboundConfig": {
		"authentication": {
			"authType": "WEBHOOK"
		},
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "Status",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"attrValues": [{
				"attrValue": "Open",
				"thirdPartyAttrValue": "In Progress"
			}, {
				"attrValue": "Closed",
				"thirdPartyAttrValue": "Completed"
			}]
		}, {
			"name": "Status",
			"thirdPartyAttrName": "Status",
			"entityType": "INCIDENT",
			"thirdPartyEntityType": "TICKET",
			"attrValues": [{
				"attrValue": "Open",
				"thirdPartyAttrValue": "In Progress"
			}, {
				"attrValue": "Closed",
				"thirdPartyAttrValue": "Completed"
			}]
		}, {
			"name": "Priority",
			"thirdPartyAttrName": "severity",
			"entityType": "INCIDENT",
			"thirdPartyEntityType": "TICKET",
			"attrValues": [{
				"attrValue": "High",
				"thirdPartyAttrValue": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}, {
			"name": "Priority",
			"thirdPartyAttrName": "severity",
			"entityType": "SERVICEREQUEST",
			"thirdPartyEntityType": "SRQ",
			"attrValues": [{
				"attrValue": "High",
				"thirdPartyAttrValue": "Max"
			}, {
				"attrValue": "Low",
				"thirdPartyAttrValue": "min"
			}]
		}]
	},
	"outboundConfig": {
		"mapAttributes": [{
			"name": "Status",
			"thirdPartyAttrName": "stats",
			"entityType": "INCIDENT",
			"thirdPartyEntityType": "Ticket",
			"attrValues": [{
				"attrValue": "Open",
				"thirdPartyAttrValue": "In Progress"
			}, {
				"attrValue": "Closed",
				"thirdPartyAttrValue": "Completed"
			}]
		}],
		"baseNotifier": {
			"type": "REST_API",
			"baseURI": "www.google.com",
			"authType": "OAUTH2",
			"grantType": "PASSWORD",
			"userName": "testUser",
			"password": "*************",
			"accessTokenURL": "www.token.com/cred",
			"apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
			"apiSecret": "***************************"
		}
	}
}

Sample response

{
  "id": "INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761",
  "integration": {
    "id": "CASERVICEDESK",
    "name": "Service Desk"
  },
  "inboundConfig": {
    "authentication": {
      "authType": "WEBHOOK",
      "token": "YTxSGJdfkkfE3m7WaE8jYkwmsYjNU3VU"
    },
    "mapAttributes": [
      {
        "name": "Status",
        "attrName": "serviceRequest.status.name",
        "thirdPartyAttrName": "Status",
        "entityType": "SERVICEREQUEST",
        "thirdPartyEntityType": "SRQ",
        "attrValues": [
          {
            "attrValue": "Open",
            "thirdPartyAttrValue": "In Progress"
          },
          {
            "attrValue": "Closed",
            "thirdPartyAttrValue": "Completed"
          }
        ]
      },
      {
        "name": "Status",
        "attrName": "incident.status.name",
        "thirdPartyAttrName": "stats",
        "entityType": "INCIDENT",
        "thirdPartyEntityType": "Ticket",
        "attrValues": [
          {
            "attrValue": "Ok",
            "thirdPartyAttrValue": "good"
          },
          {
            "attrValue": "Critical",
            "thirdPartyAttrValue": "bad"
          },
          {
            "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"
          }
        ]
      },
      {
        "name": "Priority",
        "attrName": "serviceRequest.priority.name",
        "thirdPartyAttrName": "severity",
        "entityType": "SERVICEREQUEST",
        "thirdPartyEntityType": "SRQ",
        "attrValues": [
          {
            "attrValue": "High",
            "thirdPartyAttrValue": "Max"
          },
          {
            "attrValue": "Low",
            "thirdPartyAttrValue": "min"
          }
        ]
      }
    ]
  },
  "outboundConfig": {
    "baseNotifier": {
      "baseURI": "www.google.com",
      "authType": "OAUTH2",
      "grantType": "PASSWORD",
      "userName": "testUser",
      "apiKey": "6h67PAAFscVPMwhQZFcshpcqN5b6pyU9",
      "accessTokenURL": "www.token.com/cred"
    },
    "mapAttributes": [
      {
        "name": "Status",
        "attrName": "incident.status.name",
        "thirdPartyAttrName": "stats",
        "entityType": "INCIDENT",
        "thirdPartyEntityType": "Ticket",
        "attrValues": [
          {
				"attrValue": "Open",
				"thirdPartyAttrValue": "In Progress"
			}, {
				"attrValue": "Closed",
				"thirdPartyAttrValue": "Completed"
			}
        ]
      }
    ]
  }
}

Sample 2 - Update integration with dropAlertsOnUnmanagedResources value

https://api.opsramp.com/api/v2/tenants/client_8/integrations/installed/INTG-9c584c86-4ba9-4006-9ee2-c41a07b7c761

Sample request

{
    "inboundConfig" : {
        "dropAlertsOnUnmanagedResources" : "false"
    }
}

Sample response

{
    "id": "INTG-8c74ef46-646f-498c-88db-43da8225b00d",
    "displayName": "API Testing1",
    "integration": {
        "id": "CUSTOM",
        "name": "Custom",
        "multipleInstallations": true
    },
    "inboundConfig": {
        "dropAlertsOnUnmanagedResources": false
    },
    "category": "Monitoring",
    "alertSource": {
        "id": 29,
        "name": "Custom",
        "displayName": "Custom",
        "techUid": "CUSTOM"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-10-28T21:01:55+0000",
    "status": "enabled"
}