Avisi cloud logo
Cloud accounts

Update a cloud account in an organisation.

PATCH
/api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}

Request Body

application/jsonRequired

displayNamestring

Minimum length: 3Maximum length: 64Pattern: "^[a-zA-Z0-9\\-\\s&]*$"

enabledboolean

primaryCloudCredentialsstring

Format: "uuid"

Path Parameters

organisationSlug
Required
string

Pattern: "^[a-z0-9-]+$"

cloudAccountIdentity
Required
string

Format: "uuid"
curl -X PATCH "https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "string",
    "enabled": true,
    "primaryCloudCredentials": "cbd71ea5-a0d4-453b-ae17-aefacbd89ad8"
  }'

Request was successfully processed. The response body contains the requested data.

{
  "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"
}

Previous

Set Primary Cloud Credentials POST

Next

List available cloud profiles for an organisation. GET