Cloud Integration

This endpoint is used to install AWS, Azure, or Google integration.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{clientId}/integrations/install/AWS
POST https://{api-url}/api/v2/tenants/{clientId}/integrations/install/AZURE
POST https://{api-url}/api/v2/tenants/{clientId}/integrations/install/GOOGLE

Sample URLs

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

Supported Fields

All fields are mandatory:

FieldData typeDescription
displayNameStringThe app name.
credentialStringCloud API Integration credentials.

Installation for Azure Type ARM

Sample Request

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

Sample Response

{
	"id" : "INTG-2e2854c6-8543-4a3c-be29-3ccc20542375",
	"integration" : {
		"id" : "AZURE",
		"name" : "Azure"
	},
	"credential" : {
		"Name" : "AZURE Azure Integration",
		"SubscriptionId" : "***********",
		"AzureType" : "ARM",
		"TenantId" : "************",
		"ClientID" : "************"
	}
}

Installation for AWS Type IAM

Sample Request

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

Sample Response

{
	"id" : "INTG-b898d6b4-cbf6-4863-a050-3ce5f3658a85",
	"integration" : {
		"id" : "AWS",
		"name" : "AWS"
	},
	"credential" : {
		"Name" : "AWS AWS Integration",
		"AccountNumber" : "326542154381",
		"AWSType" : "IAM",
                "Regions" : "All"
	}
}

Installation for AWS Type IAM with AssumeRole

Sample Request

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

Sample Response

{
	"id" : "INTG-c128dcb9-a9b2-40de-af8e-2a07c3b81d57",
	"integration" : {
		"id" : "AWS",
		"name" : "AWS"
	},
	"credential" : {
		"Name" : "AWS AWS Integration",
		"AccountNumber" : "326542154381",
		"AWSType" : "IAM",
                "Regions" : "us-east-1"
	}
}

Installation for Azure Type ASM

Sample Request

{
	"displayName" : "AZURE",
	"credential" : {
		"credentialType" : "AZURE",
		"SubscriptionId" : "*************",
		"AzureType" : "ASM",
		"ManagementCertificate" : "**********",
		"KeystorePassword" : "**********"
	}
}

Sample Response

{
	"id" : "INTG-845ds218-9978-4a45-ac48-4b118d560514",
	"integration" : {
		"id" : "AZURE",
		"name" : "Azure"
	},
	"credential" : {
		"Name" : "Azure AZURE Integration",
		"SubscriptionId" : "************",
		"AzureType" : "ASM"
	}
}{
	"id" : "INTG-845ds218-9978-4a45-ac48-4b118d560514",
	"integration" : {
		"id" : "AZURE",
		"name" : "Azure"
	},
	"credential" : {
		"Name" : "Azure AZURE Integration",
		"SubscriptionId" : "************",
		"AzureType" : "ASM"
	}
}

Installation for 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" : "********************************"
	}
}