Cloud accounts
Create a cloud account in an organisation.
Request Body
application/json
RequireddisplayName
RequiredstringMinimum length:
1
Maximum length: 64
Pattern: "^[a-zA-Z0-9\\-\\s&]*$"
metadata
objectcloudProfile
RequiredstringMinimum length:
0
Maximum length: 64
Path Parameters
organisationSlug
RequiredstringPattern:
"^[a-z0-9-]+$"
Response Body
Request was successfully processed. The response body contains the requested data.
TypeScript Definitions
Use the response body type in TypeScript.
identity
stringFormat:
"uuid"
displayName
stringmetadata
objectcloudProfile
objectenabled
booleanprimaryCloudCredentialsIdentity
stringFormat:
"uuid"
curl -X POST "https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts" \
-H "Content-Type: application/json" \
-d '{
"displayName": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"cloudProfile": "string"
}'
{
"identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
"displayName": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"cloudProfile": {
"identity": "string",
"displayName": "string",
"metadata": {
"property1": "string",
"property2": "string"
},
"cloudProvider": "string",
"regions": [
"string"
],
"enabled": true,
"type": "aws",
"cloudProviderResponse": {
"id": 0,
"name": "string",
"slug": "string",
"available": true,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z",
"logo": "string",
"byon": true,
"type": "aws",
"privateClusterSetting": "UNAVAILABLE",
"metadata": {
"property1": "string",
"property2": "string"
},
"validateCloudCredentials": true
},
"cloudProviderRegionResponses": [
{
"id": 0,
"provider": "string",
"name": "string",
"slug": "string",
"available": true,
"restricted": true,
"createdAt": "2019-08-24T14:15:22Z",
"modifiedAt": "2019-08-24T14:15:22Z"
}
],
"public": true
},
"enabled": true,
"primaryCloudCredentialsIdentity": "962b660f-35b8-4ef0-9e6d-6f86f64922e0"
}