Skip to main content

Update Cloud Connection​

Select

SaaS
Customer Managed

Update configuration of an existing cloud connection.

Path Parameters
  • cloudConnectionId int32 required

    Id of an existing cloud connection

Request Body
  • displayName string

    Display name of the cloud connection.

  • credentials object

    Credentials for cloud connections

  • credentialType CloudConnectionCredentialType

    Possible values: [AWS_STS_ASSUME_ROLE, AWS_IAM_ROLE]

    Type of credential to be used to access cloud connection.

  • credentialId int32

    ID of the saved credentials.

  • accessNodes object[]

    List of servers and server groups to use to access the cloud connection.

  • cloudSpecificConfiguration object

    Configuration settings specific to the connections cloud type.

  • aws object

    AWS specific cloud connection configuration.

  • regions string

    List of AWS regions to connect to.

  • iamRoleAccountId string

    ID of the AWS account which contains the IAM role to assume for authentication.

  • azure object

    Azure specific cloud connection configuration.

  • tenantId string

    Azure Tenant Id

  • tenantName string

    Azure Tenant Name

  • environment string

    Azure environment

  • subscriptions object[]

    List of Azure Subscriptions

  • name string

    cloud account name

  • id string

    cloud account id

  • uuid string

    The globally unique identifier for the account

  • email string

    email for cloud account

  • discoverAllSubscription boolean

    Default value: false

    Automatically discover future subscription in Azure tenant.

Responses

Success

PUT /v4/cloud/cloudconnection/:cloudconnectionid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
cloudConnectionId — path required
Body
{

  "displayName": "string",

  "credentials": {

    "credentialType": "AWS_STS_ASSUME_ROLE",

    "credentialId": 0

  },

  "accessNodes": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "accessNodeType": "SERVER"

    }

  ],

  "cloudSpecificConfiguration": {

    "aws": {

      "regions": "string",

      "iamRoleAccountId": "string"

    },

    "azure": {

      "tenantId": "string",

      "tenantName": "string",

      "environment": "string",

      "subscriptions": [

        {

          "name": "string",

          "id": "string",

          "uuid": "string",

          "email": "string"

        }

      ],

      "discoverAllSubscription": false

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "displayName": "string",
  "credentials": {
    "credentialType": "AWS_STS_ASSUME_ROLE",
    "credentialId": 0
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "cloudSpecificConfiguration": {
    "aws": {
      "regions": "string",
      "iamRoleAccountId": "string"
    },
    "azure": {
      "tenantId": "string",
      "tenantName": "string",
      "environment": "string",
      "subscriptions": [
        {
          "name": "string",
          "id": "string",
          "uuid": "string",
          "email": "string"
        }
      ],
      "discoverAllSubscription": false
    }
  }
}'