Avisi cloud logo
Cloud accounts

Update a cloud account in an organisation.

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

Request Body

application/jsonRequired
displayName?string
Pattern"^[a-zA-Z0-9\\-\\s&]*$"
Length3 <= length <= 64
enabled?boolean
primaryCloudCredentials?string
Format"uuid"

Path Parameters

organisationSlugstring
Pattern"^[a-z0-9-]+$"
cloudAccountIdentitystring
Format"uuid"

Response Body

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

TypeScript Definitions

Use the response body type in TypeScript.

identity?string
Format"uuid"
displayName?string
metadata?object

Empty Object

cloudProfile?object
enabled?boolean
primaryCloudCredentialsIdentity?string
Format"uuid"

Invalid request parameters. Please review the documentation for valid parameter values.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

You do not have the necessary permissions to access this resource.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

The requested resource could not be found. Please check the resource URL or identifier.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

An internal error occurred on the server.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown
curl -X PATCH "https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{}'
const body = JSON.stringify({})

fetch("https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
  body := strings.NewReader(`{}`)
  req, _ := http.NewRequest("PATCH", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.avisi.cloud/api/v1/orgs/string/cloud-accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08"
body = {}
response = requests.request("PATCH", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "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"
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}