Get Cloud Connection Details

Select

SaaS

Customer Managed

Get details of one cloud connection

Path Parameters

• cloudConnectionId int32 required

  Id of an existing cloud connection

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• cloudConnection object

  Summary of a cloud connection entity

  id int32

  name string

  displayName string

  cloudType CloudConnectionCloudType

  Possible values: [AMAZON_WEB_SERVICES, MICROSOFT_AZURE]

  Cloud type for the 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 connection.

  id int32

  name string

  displayName string

  accessNodeType AccessNodeItemType

  Possible values: [SERVER, SERVER_GROUP]

  Type of access node item

  cloudSpecificDetails object

  Details specific to 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.

  accountDetails object

  Details about the onboarded account.

  cloudAccount object

  cloud account details

  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

  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.

{
  "cloudConnection": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "cloudType": "AMAZON_WEB_SERVICES",
    "credentials": {
      "credentialType": "AWS_STS_ASSUME_ROLE",
      "credentialId": 0
    },
    "accessNodes": [
      {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "accessNodeType": "SERVER"
      }
    ],
    "cloudSpecificDetails": {
      "aws": {
        "regions": "string",
        "iamRoleAccountId": "string",
        "accountDetails": {
          "cloudAccount": {
            "name": "string",
            "id": "string",
            "uuid": "string",
            "email": "string"
          }
        }
      },
      "azure": {
        "tenantId": "string",
        "tenantName": "string",
        "environment": "string",
        "subscriptions": [
          {
            "name": "string",
            "id": "string",
            "uuid": "string",
            "email": "string"
          }
        ],
        "discoverAllSubscription": false
      }
    }
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string

  Tells about the error occured

• errorCode ErrorCode

  Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

  Error code value

{
  "errorMessage": "string",
  "errorCode": "NO_ERROR"
}

GET /v4/cloud/cloudconnection/:cloudconnectionid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

cloudConnectionId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/CloudConnection/:cloudConnectionId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'