Documentation is now available for the Fall 2020 Update release!

Cloud Integration

This endpoint is used to install AWS, Azure, Google, Kubernetes (K8S), K3S, and OKD integrations.

Leave Feedback

URL

To create the cloud installation:

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/{integrationName}

To update the installed cloud integration:

POST https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/{integrationId}

Sample URLs

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/AWS
POST https://{api-url}/api/v2/tenants/client_9/integrations/install/AZURE
POST https://{api-url}/api/v2/tenants/client_8/integrations/install/GOOGLE
POST https://{api-url}/api/v2/tenants/client_9/integrations/install/KUBERNETES
POST https://{api-url}/api/v2/tenants/client_9/integrations/install/K3S
POST https://{api-url}/api/v2/tenants/client_9/integrations/install/OKD

Header format

HeaderValue
AuthorizationBearer {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

All fields are mandatory unless specified otherwise.

FieldData TypeDescription
displayNameStringThe app name.
credentialJSONObjectCloud API Integration credentials.
discoveryProfilesJSONArray(Optional) Even though it is a JSON array, only the first JSONObject is considered in the array. If this field is not provided, a default discoveryProfile is created.
policyJSONObject(Optional) Set of functions formed together as a policy and attached with the discovery profile.
entityTypeString(Optional) Values: ALL or ANY. Default: ALL
  • ALL - for creating "Smart filters" -FilterCriteria Type.
  • ANY - for creating "Resource Filters" - FilterCriteria Type
matchTypeString(Optional) Values: ALL or ANY. Default: ANY
rulesJSONArray(Optional) Default: ANY_CLOUD_RESOURCE" filterType. For example: "All Resources" Smart Filter
actionsJSONArray(Optional) No action items are applied by default.
scheduleJSONObject(Optional) Schedule will not be applied by default.
scanNowBoolean(Optional) Values: true/false. This boolean triggers a scan while creating or updating a discovery profile. Default: false
deploymentStringSpecifies the K8S deployment environment where K8S cluster is on-premise cluster or deployed using a cloud provider.

Values: cloud, onPrem

containerEngineTypeStringSpecifies the container runtime engine.

Values: Docker, ContainerD

See Create discovery profile for more information about filter criteria, actions, and scheduling.

AWS samples

AWS payload

URL to create a discovery profile while installing the integration:

https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/AWS

URL to create or update discovery profile along with the integration:

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

Sample URL to create an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/install/AWS 

Sample URL to update an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/installed/INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320

Sample request

{
	"displayName": "iam_role",
	"credential": {
		"credentialType": "AWS",
		"Regions": "us-east-1",
		"AWSType": "IAM",
		"AccountNumber": "**************",
		"AccessKey": "***********************",
		"SecurityKey": "***********************"
	},
	"discoveryProfiles": [
		{
			"scanNow": "false",
			"policy": {
				"entityType": "ALL",
				"matchType": "ANY",
				"rules": [
					{		
                        "filterType": "ANY_CLOUD_RESOURCE"
					}
				],
                "actions" : [
                    {
		                "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
		                "items": [{
		                    "item": "24422"
		                }]
		            },
		            {
						"action" : "MANAGE DEVICE",
						"items" : []
					},
					{
						"action" : "STREAM AWS ALERTS",
						"items" : [
							{
								"item" : "https://cloudwatch-url"
							}
						]
					}		            
                ]
			},
			"schedule" : {
				"patternType" : "MINUTES",
				"pattern" : "30",
				"startTime" : "00:30:00"
			}			
		}
	]
}

Sample response

{
    "id": "INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320",
    "displayName": "iam_role",
    "integration": {
        "id": "AWS",
        "name": "AWS",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "iam_role AWS Integration",
        "autoMonitorable": false,
        "AccountNumber": "*************",
        "AWSType": "IAM",
        "Regions": "us-east-1"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T13:45:51+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_iam_role",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": [
                    {
                        "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
                        "items": [
                            {
                                "item": "24422"
                            }
                        ]
                    },
                    {
                        "action": "MANAGE DEVICE"
                    },
                    {
                        "action": "STREAM AWS ALERTS",
                        "items": [
                            {
                                "item": "https://cloudwatch-url"
                            }
                        ]
                    }
                ]
            },
            "id": 8326,
            "discoveryStatusUid": "",
            "scanNow": false,
            "schedule": {
                "schedule": {
                    "patternType": "MINUTES",
                    "pattern": "30",
                    "startTime": "00:30:00"
                }
            }
        }
    ],
    "status": "enabled"
}

AWS Type IAM installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/AWS

Sample request

{
  "displayName":"iam_role",
  "credential" : {
	"credentialType" : "AWS",
	"AWSType" : "IAM",
	"Regions" : "All",
	"AccountNumber" : "**********",
	"AccessKey" : "*************",
	"SecurityKey" : "*************"
	}
}

Sample response

{
    "id": "INTG-f822ab26-f465-4f7f-ad63-ccf7da1a94ce",
    "displayName": "iam_role",
    "integration": {
        "id": "AWS",
        "name": "AWS",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "iam_role AWS Integration",
        "autoMonitorable": false,
        "AccountNumber": "*****************",
        "AWSType": "IAM",
        "Regions": "us-east-1"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:38:29+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_iam_role",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8318,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

AWS Type IAM with AssumeRole installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/AWS

Sample request

{
  "displayName": "AWS-AssumeRole",
  "credential" : {
		"credentialType" : "AWS",
		"AWSType" : "IAM with AssumeRole",
		"Regions": "us-east-1",
		"AccountNumber" : "**************",
		"AccessKey" : "***************",
		"SecurityKey" : "***********************************",
		"AssumeRoleARN" : "arn:aws:iam::098765432109:role/assumeRole"		
	}
}

Sample response

{
    "id": "INTG-a479d319-56df-47cd-819a-b9fe307ae0bf",
    "displayName": "AWS-AssumeRole",
    "integration": {
        "id": "AWS",
        "name": "AWS",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "AWS-AssumeRole AWS Integration",
        "autoMonitorable": false,
        "AccountNumber": "***********",
        "AWSType": "ASSUME_ROLE",
        "Regions": "us-east-1"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:49:32+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_AWS-AssumeRole",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8320,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

AWS external Id

For the externalId field, any random unique string can be given as the input. The AccountNumber is obtained from either Support or the UI (while installing the integration).

Sample request

{
  "displayName": "AWS-ExternalId",
  "credential": {
    "Regions": "All",
    "AccountNumber": "123456789012",
    "AWSType": "External Id",
    "ExternalId": "96d7e0b5-a5bf-4746-acaa-521ffbf7e5c8",
    "AssumeRoleARN": "arn:aws:iam::123456789012:role/new_ext_delete_me",
    "linkaccounts": "false",
    "credentialType": "AWS"
  }
}

Sample response

{
    "id": "INTG-9166cc9b-8621-4e8e-ac50-e91430aafa2d",
    "displayName": "AWS-ExternalId",
    "integration": {
        "id": "AWS",
        "name": "AWS",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "AWS-ExternalId-NEWUI AWS Integration",
        "autoMonitorable": false,
        "AccountNumber": "123456789012",
        "AWSType": "EXTERNAL_ID",
        "Regions": "All"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:42:20+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_AWS-ExternalId",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8319,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

AWS update for IAM

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c

Sample request

{
  "displayName":"Updated-AWS",
  "credential" : {
	"credentialType" : "AWS",
	"AWSType" : "IAM",
	"Regions" : "All",
	"AccountNumber" : "**********",
	"AccessKey" : "*************",
	"SecurityKey" : "*************"
	}
}

Sample response

{
  "id": "INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c",
  "displayName": "Updated-AWS",
  "integration": {
    "id": "AWS",
    "name": "AWS"
  },
  "credential": {
    "Name": "Updated-AWS AWS Integration",
    "AccountNumber": "**************",
    "AWSType": "IAM",
    "Regions": "All"
  },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:38:29+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_Updated-AWS",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8318,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

AWS update for IAM with AssumeRole

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c

Sample request

{
  "displayName":"Updated-AWS",
  "credential" : {
	"credentialType" : "AWS",
	"AWSType" : "IAM with AssumeRole",
	"Regions": "us-east-1",
	"AccountNumber" : "*********",
	"AccessKey" : "************",
	"SecurityKey" : "***********",
	"AssumeRoleARN" : "*********************"	
	}
}

Sample response

{
  "id": "INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c",
  "displayName": "Updated-AWS",
  "integration": {
    "id": "AWS",
    "name": "AWS"
  },
  "credential": {
    "Name": "Updated-AWS AWS Integration",
    "AccountNumber": "***************",
    "AWSType": "IAM",
    "Regions": "us-east-1"
  },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:49:32+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_Updated-AWS",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8320,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

AWS update for External Id

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c

Sample request

{
  "displayName":"Updated-AWS",  
  "credential": {
    "Regions": "All",
    "AccountNumber": "123456789012",
    "AWSType": "External Id",
    "ExternalId": "96d7e0b5-a5bf-4746-acaa-521ffbf7e5c8",
    "AssumeRoleARN": "arn:aws:iam::123456789012:role/new_ext_delete_me",
    "linkaccounts": "false",
    "credentialType": "AWS"
  }
}

Sample response

{
    "id": "INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c",
    "displayName": "Updated-AWS",
    "integration": {
        "id": "AWS",
        "name": "AWS"
    },
    "credential": {
        "Name": "Updated-AWS AWS Integration",
        "AccountNumber": "************",
        "AWSType": "External Id",
        "Regions": "All"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T10:42:20+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AWS_Updated-AWS",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8319,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
} 
}

Azure samples

Azure payload

URL to create a discovery profile while installing the integration:

https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/AZURE

URL to create or update discovery profile along with the integration:

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

Sample URL to create an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/install/AZURE 

Sample URL to update an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/installed/INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320

Sample request

{
	"displayName": "AzureARM",
	"credential": {
		"credentialType": "AZURE",
		"AzureType": "ARM",
		"SubscriptionId": "*********************************",
		"TenantId": "*********************************",
		"ClientID": "*********************************",
		"SecretKey": "*********************************"
	},
	"discoveryProfiles": [
		{
			"scanNow": "false",
			"policy": {
				"entityType": "ALL",
				"matchType": "ANY",
				"rules": [
					{		
                        "filterType": "ANY_CLOUD_RESOURCE"
					}
				],
                "actions" : [
                    {
		                "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
		                "items": [{
		                    "item": "24422"
		                }]
		            },
		            {
						"action" : "MANAGE DEVICE",
						"items" : []
					},
					{
						"action" : "AZURE EVENTHUB",
						"items" : [
							{
								"item" : "connection-string key"
							}
						]
					}		            
                ]
			},
			"schedule" : {
				"patternType" : "MINUTES",
				"pattern" : "30",
				"startTime" : "00:30:00"
			}			
		}
	]
}

Sample response

{
    "id": "INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320",
    "displayName": "AzureARM",
    "integration": {
        "id": "AZURE",
        "name": "Azure",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "AzureARM AZURE Integration",
        "autoMonitorable": false,
        "SubscriptionId": "*********************************",
        "AzureType": "ARM",
        "TenantId": "*********************************",
        "ClientID": "*********************************",
        "Environment": "AZURE"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T13:45:51+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AZURE_AzureARM",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": [
                    {
                        "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
                        "items": [
                            {
                                "item": "24422"
                            }
                        ]
                    },
                    {
                        "action": "MANAGE DEVICE"
                    },
                    {
                        "action": "AZURE EVENTHUB",
                        "items": [
                            {
                                "item": "connection-string key"
                            }
                        ]
                    }
                ]
            },
            "id": 8326,
            "discoveryStatusUid": "",
            "scanNow": false,
            "schedule": {
                "schedule": {
                    "patternType": "MINUTES",
                    "pattern": "30",
                    "startTime": "00:30:00"
                }
            }
        }
    ],
    "status": "enabled"
}

Azure Type ARM installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/AZURE

Sample request

{
    "displayName":"AzureARM",	
	"credential": {
		"credentialType": "AZURE",
		"AzureType": "ARM",
		"SubscriptionId": "*********************************",
		"TenantId": "*********************************",
		"ClientID": "*********************************",
		"SecretKey": "*********************************"
	}
}

Sample response

{
    "id": "INTG-308a6e08-d270-49d4-9a4d-b04538f2010b",
    "displayName": "AzureARM",
    "integration": {
        "id": "AZURE",
        "name": "Azure",
        "multipleInstallations": true
    },
    "credential": {
        "Name": "AzureARM AZURE Integration",
        "autoMonitorable": false,
        "SubscriptionId": "*********************************",
        "AzureType": "ARM",
        "TenantId": "*********************************",
        "ClientID": "*********************************",
        "Environment": "AZURE"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T11:25:46+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AZURE_AzureARM",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8321,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

Azure update

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c

Sample request

{
  "displayName":"Updated-Azure",
  "credential" : {
	"credentialType" : "AZURE",
	"SubscriptionId" : "*************",
	"AzureType" : "ARM",
	"TenantId" : "**********",
	"ClientID" : "**********",
	"SecretKey" : "*********"
	}
}

Sample response

{
  "id": "INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c",
  "displayName":"Updated-Azure",
  "integration": {
    "id": "AZURE",
    "name": "Azure"
  },
  "credential": {
    "Name": "Updated-Azure AZURE Integration",
    "SubscriptionId": "*****************",
    "AzureType": "ARM",
    "TenantId": "************************",
    "ClientID": "*****************************"
  },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T11:25:46+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "AZURE_Updated-Azure",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8321,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

Google samples

Google payload

URL to create a discovery profile while installing the integration:

https://{api-url}/api/v2/tenants/{tenantId}/integrations/install/GOOGLE

URL to create or update discovery profile along with the integration:

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

Sample URL to create an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/install/GOOGLE 

Sample URL to update an integration:

https://{api-url}/api/v2/tenants/client_453/integrations/installed/INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320

Sample request

{
    "displayName":"Google",
    "credential" : { 
		"credentialType":"GOOGLE", 
		"ServiceAccountEmail":"*****************", 
		"ProjectId":"**********", 
		"ServiceAccountManagementCertificate":"*********",
		"ManagementCertificatePassPhrase":"*********"
	},
	"discoveryProfiles": [
		{
			"scanNow": "false",
			"policy": {
				"entityType": "ALL",
				"matchType": "ANY",
				"rules": [
					{		
                        "filterType": "ANY_CLOUD_RESOURCE"
					}
				],
                "actions" : [
                    {
		                "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
		                "items": [{
		                    "item": "24422"
		                }]
		            },
		            {
						"action" : "MANAGE DEVICE",
						"items" : []
					},
					{
						"action" : "GOOGLE EVENTS",
						"items" : [
							{
								"item" : "subscription name"
							}
						]
					}		            
                ]
			},
			"schedule" : {
				"patternType" : "MINUTES",
				"pattern" : "30",
				"startTime" : "00:30:00"
			}			
		}
	]
}

Sample response

{
    "id": "INTG-537e2031-63fe-41f0-bbf2-6bc5dec16320",
    "displayName": "Google",
    "integration": {
        "id": "GOOGLE",
        "name": "Google"
    },
    "credential": {
        "Name": "Google GOOGLE Integration",
        "ProjectId": "********************",
        "ServiceAccountEmail": "********************************"
    },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T13:45:51+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "GOOGLE_Google",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": [
                    {
                        "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
                        "items": [
                            {
                                "item": "24422"
                            }
                        ]
                    },
                    {
                        "action": "MANAGE DEVICE"
                    },
                    {
						"action" : "GOOGLE EVENTS",
						"items" : [
							{
								"item" : "subscription name"
							}
						]
					}	
                ]
            },
            "id": 8326,
            "discoveryStatusUid": "",
            "scanNow": false,
            "schedule": {
                "schedule": {
                    "patternType": "MINUTES",
                    "pattern": "30",
                    "startTime": "00:30:00"
                }
            }
        }
    ],
    "status": "enabled"
}

Google installation

POST https://{api-url}/api/v2/tenants/client_8/integrations/install/GOOGLE

Sample request

{
	"displayName" : "Google",
	"credential" : {
		"credentialType" : "GOOGLE",
		"ServiceAccountEmail" : "*****************",
		"ProjectId" : "**********",
		"ServiceAccountManagementCertificate" : "*********",
		"ManagementCertificatePassPhrase" : "*********"
	}
}

Sample response

{
  "id": "INTG-948776fe-7f27-4ba0-86d3-28dcc2a30297",
  "integration": {
    "id": "GOOGLE",
    "name": "Google"
  },
  "credential": {
    "Name": "Google GOOGLE Integration",
    "ProjectId": "********************",
    "ServiceAccountEmail": "********************************"
  },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T11:29:46+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "GOOGLE_Google",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8322,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

Google update

https://{api-url}/api/v2/tenants/client_8/integrations/installed/INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c

Sample request

{
  "displayName":"Updated-Google",
  "credential" : { 
		"credentialType":"GOOGLE", 
		"ServiceAccountEmail":"*****************", 
		"ProjectId":"**********", 
		"ServiceAccountManagementCertificate":"*********",
		"ManagementCertificatePassPhrase":"*********"
	}
}

Sample response

{
  "id": "INTG-c8abcfdf-c3c1-4aa7-88d3-d627a70f416c",
   "displayName":"Updated-Google",
  "integration": {
    "id": "GOOGLE",
    "name": "Google"
  },
  "credential": {
    "Name": "Updated-Google GOOGLE Integration",
    "ProjectId": "********************",
    "ServiceAccountEmail": "********************************"
  },
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-28T11:29:46+0100",
    "discoveryProfiles": [
        {
            "policy": {
                "name": "GOOGLE_Updated-Google",
                "entityType": "ALL",
                "matchType": "ANY",
                "rules": [
                    {
                        "filterType": "ANY_CLOUD_RESOURCE"
                    }
                ],
                "actions": []
            },
            "id": 8322,
            "discoveryStatusUid": "",
            "scanNow": false
        }
    ],
    "status": "enabled"
}

Kubernetes samples

Kubernetes installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/KUBERNETES

Sample request

{
	"displayName":"Kube-Intg",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7",
    "displayName": "Kube-Intg",
    "integration": {
        "id": "KUBERNETES",
        "name": "Kubernetes",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_498/integrations/installed/INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_498/integrations/installed/INTG-3dabbf8d-af66-4a4f-a8d4-d7ffeb496ba7/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-24T05:07:28+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}

Kubernetes in auto-monitorable client installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/KUBERNETES

Sample request

{
	"displayName":"Kube-Intg",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-fe47151c-7be3-47e9-9cd2-19002271f40c",
    "displayName": "Kube-Intg",
    "integration": {
        "id": "KUBERNETES",
        "name": "Kubernetes",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "auto-detection-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-fe47151c-7be3-47e9-9cd2-19002271f40c/configFile/auto-detection-config-map"
        },
        {
            "id": 0,
            "name": "creds-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-fe47151c-7be3-47e9-9cd2-19002271f40c/configFile/creds-config-map"
        },
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-fe47151c-7be3-47e9-9cd2-19002271f40c/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-fe47151c-7be3-47e9-9cd2-19002271f40c/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-24T05:13:44+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}

OKD samples

OKD installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/OKD

Sample request

{
	"displayName":"OKDAPI",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-e11081cb-406a-4416-9d9e-f8afad28ba27",
    "displayName": "OKDAPI",
    "integration": {
        "id": "OKD",
        "name": "Red Hat OpenShift (OKD)",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_683/integrations/installed/INTG-e11081cb-406a-4416-9d9e-f8afad28ba27/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_683/integrations/installed/INTG-e11081cb-406a-4416-9d9e-f8afad28ba27/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-25T08:33:08+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}

OKD in auto-monitorable client installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/OKD

Sample request

{
	"displayName":"OKDAPI",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-77e07d21-af24-41c4-a65a-83e04225bbec",
    "displayName": "OKDAPI",
    "integration": {
        "id": "OKD",
        "name": "Red Hat OpenShift (OKD)",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "auto-detection-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-77e07d21-af24-41c4-a65a-83e04225bbec/configFile/auto-detection-config-map"
        },
        {
            "id": 0,
            "name": "creds-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-77e07d21-af24-41c4-a65a-83e04225bbec/configFile/creds-config-map"
        },
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-77e07d21-af24-41c4-a65a-83e04225bbec/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-77e07d21-af24-41c4-a65a-83e04225bbec/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-25T08:30:30+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}

K3S samples

K3S installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/K3S

Sample request

{
	"displayName":"K3SAPI",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-c1b45993-1f23-4801-af47-d721cec963db",
    "displayName": "K3SAPI",
    "integration": {
        "id": "K3S",
        "name": "K3S",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_683/integrations/installed/INTG-c1b45993-1f23-4801-af47-d721cec963db/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_683/integrations/installed/INTG-c1b45993-1f23-4801-af47-d721cec963db/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-25T08:35:18+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}

K3S in auto-monitorable client installation

POST https://{api-url}/api/v2/tenants/client_9/integrations/install/K3S

Sample request

{
	"displayName":"K3SAPI",
	"deployment" : "onPrem",
	"containerEngineType" : "Docker"
}

Sample response

{
    "id": "INTG-0100e90e-3efb-4383-a69b-32c87f271eb6",
    "displayName": "K3SAPI",
    "integration": {
        "id": "K3S",
        "name": "K3S",
        "multipleInstallations": true
    },
    "deployment": "onPrem",
    "configFiles": [
        {
            "id": 0,
            "name": "auto-detection-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-0100e90e-3efb-4383-a69b-32c87f271eb6/configFile/auto-detection-config-map"
        },
        {
            "id": 0,
            "name": "creds-config-map.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-0100e90e-3efb-4383-a69b-32c87f271eb6/configFile/creds-config-map"
        },
        {
            "id": 0,
            "name": "Kubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-0100e90e-3efb-4383-a69b-32c87f271eb6/configFile/Kubernetes"
        },
        {
            "id": 0,
            "name": "statsDMonitoringKubernetes.yaml",
            "contentURL": "https://cloud-native.api.opsramp.net/api/v2/tenants/client_673/integrations/installed/INTG-0100e90e-3efb-4383-a69b-32c87f271eb6/configFile/statsDMonitoringKubernetes"
        }
    ],
    "installedBy": "opsramp_api_user",
    "installedTime": "2020-09-25T08:36:59+0100",
    "containerEngineType": "Docker",
    "status": "enabled"
}