URL
POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/{intgId}
Headers
- Authorization: Bearer {accessToken}
- Content-Type: application/json
- Accept: application/json
Status code
200 OK
This API is not supported for deployment, email requests, and other category integrations.
Supported integrations
The following cloud integrations are supported:
- AWS integrations
- Azure integration
- Google integration
Parameters
Field | Data Type | Description |
---|---|---|
dropAlertsOnUnmanagedResources | Boolean | (Optional) When enabled, this parameter discards alerts from resources that are unmanaged. Applicable only for monitoring integration. Options: true/false. Default: false |
Sample URL
https://{api-url}/api/v2/tenants/client_8/integrations/install/PINGDOM
Sample response
{
"id": "INTG-74640545-0895-4924-9261-250ce5ce7ad5",
"integration": {
"id": "PINGDOM",
"name": "Pingdom"
}
}
Sample 1 - Install integrations with a display name and integration logo
Install integrations and customize the display name and logo of the integrations. This applies only for custom and email alert integrations.
Sample request
{
"displayName": "Test Integration",
"logo": {
"name": "test.png",
"file": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUSExMVFhUVGBcXFhcYGBgaFxgVFRUYFxcYFRcYHSggHh8lGxsXIjEiJSkrLi4wFx8zODMtOCgtLisBCgoKDg0OGxAQGy0lICYtLS0tLy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLf/AABEIAHABwwMBEQACEQEDEQH/xAAcAAEAAgIDAQAAAAAp8j1D+zC/vI1R5usr1w5LeIXrhyW8RLd0GZTzYzPDR9FmJ/EcB5FdNOFM/FLppwpn45SvJ2S4oBaNgF9p2uPeSu3HirSPww7seKuOPwwzFo0EBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQf//Z"
}
}
Sample response
{
"id": "INTG-b95d0d73-e904-4059-915c-7380396af61c",
"displayName": "Test Integration",
"integration": {
"id": "CUSTOM",
"name": "Custom"
}
}
Sample 2 - Install integration with parent inheritance
Install an integration by inheriting a parent integration. Configuration details such as notification type, basic URI, and authentication type are inherited by the integration.
Only custom integrations support parent integration inheritance.
Sample request
{
"displayName": "Logix Integration",
"parentIntg": {
"id": "INTG-f3e44188-83d9-4efc-82d1-68b07b740f0b"
}
}
Sample response
{
"id": "INTG-d4c2a1b3-0520-4e24-809f-b1a2857b88ac",
"displayName": "Logix Integration",
"integration": {
"id": "CUSTOM",
"name": "Custom"
}
}
Sample 3 - Install integration with dropAlertsOnUnmanagedResources value set
Applicable only for Monitoring category integrations.
https://api.opsramp.com/api/v2/tenants/client_8/integrations/install/PINGDOM
Sample request
{
"inboundConfig" : {
"dropAlertsOnUnmanagedResources" : "true"
}
}
Sample response
{
"id": "INTG-90c87b1a-40ac-4614-bb0f-3a0b15e17616",
"integration": {
"id": "PINGDOM",
"name": "Pingdom",
"multipleInstallations": false
},
"inboundConfig": {
"authentication": {
"authType": "WEBHOOK",
"token": "73qGxKYUAsqgma5PfcTSxTucdtZvkcgR"
},
"dropAlertsOnUnmanagedResources": true
},
"installedBy": "opsramp_api_user",
"installedTime": "2020-10-28T21:15:15+0000",
"status": "enabled"
}