Skip to main content

Create cleanroom target​

Select

SaaS
Customer Managed

Create cleanroom target for automation of resources

Request Body
  • name string

    Name of the target

  • vendor string

    Possible values: [NONE, AZURE_V2, AMAZON]

    The vendor where the target needs to be created

  • hypervisor object required

    Options to provide an existing hypervisor or create a new one

  • entity object
  • id int32
  • name string
  • optionsAzure object

    Create a hypervisor group

  • name string required

    The name of the hypervisor group being created

  • skipCredentialValidation boolean

    Default value: false

    if credential validation has to be skipped.

  • accessNodes object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • credentials object
  • id int32
  • name string
  • etcdProtection object

    Create an application group etcd (system generated) with pre-defined content

  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • enableCloudConfigProtection boolean

    Default value: false

    Protect Cloud Config entities

  • workloadType string
  • workloadRegion object
  • id int32
  • name string
  • hypervisorType string required

    Possible values: [AZURE_V2]

  • useManagedIdentity boolean

    Default value: false

    set to true, if you want to use System Managed identitiy of Access node for Authentication

  • subscriptionId string required

    Subscription ID of Azure

  • optionsAmazon object

    Create a hypervisor group

  • name string required

    The name of the hypervisor group being created

  • skipCredentialValidation boolean

    Default value: false

    if credential validation has to be skipped.

  • accessNodes object[]
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • credentials object
  • id int32
  • name string
  • etcdProtection object

    Create an application group etcd (system generated) with pre-defined content

  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • enableCloudConfigProtection boolean

    Default value: false

    Protect Cloud Config entities

  • workloadType string
  • workloadRegion object
  • id int32
  • name string
  • hypervisorType string required

    Possible values: [Amazon]

  • accessKey string required

    Access Key of Amazon login

  • RoleARN string

    Role ARN for STS assume role with IAM policy

  • secretKey string required

    secret Key of Amazon login

  • Region string

    AWS region if Iam role is used

  • useIamRole boolean required

    if Iam Role is used

  • enableAWSAdminAccount boolean
  • useServiceAccount string

    Clientname to be used as Admin Account

  • useHostedInfrastructure boolean

    Use Metallic hosted infrastructure

  • accessNode object
  • id int32
  • name string
  • displayName string

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • region object required
  • guid string
  • name string
Responses

Success

Schema
  • id int32
  • name string
POST /cleanroom/target

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "name": "string",

  "vendor": "NONE",

  "hypervisor": {

    "entity": {

      "id": 0,

      "name": "string"

    },

    "optionsAzure": {

      "name": "string",

      "skipCredentialValidation": false,

      "accessNodes": [

        {

          "id": 0,

          "name": "string",

          "displayName": "string",

          "type": 0

        }

      ],

      "credentials": {

        "id": 0,

        "name": "string"

      },

      "etcdProtection": {

        "enabled": true,

        "plan": {

          "id": 0,

          "name": "string"

        }

      },

      "planEntity": {

        "id": 0,

        "name": "string"

      },

      "enableCloudConfigProtection": false,

      "workloadType": "string",

      "workloadRegion": {

        "id": 0,

        "name": "string"

      },

      "hypervisorType": "AZURE_V2",

      "useManagedIdentity": false,

      "subscriptionId": "string"

    },

    "optionsAmazon": {

      "name": "string",

      "skipCredentialValidation": false,

      "accessNodes": [

        {

          "id": 0,

          "name": "string",

          "displayName": "string",

          "type": 0

        }

      ],

      "credentials": {

        "id": 0,

        "name": "string"

      },

      "etcdProtection": {

        "enabled": true,

        "plan": {

          "id": 0,

          "name": "string"

        }

      },

      "planEntity": {

        "id": 0,

        "name": "string"

      },

      "enableCloudConfigProtection": false,

      "workloadType": "string",

      "workloadRegion": {

        "id": 0,

        "name": "string"

      },

      "hypervisorType": "Amazon",

      "accessKey": "string",

      "RoleARN": "string",

      "secretKey": "string",

      "Region": "string",

      "useIamRole": true,

      "enableAWSAdminAccount": true,

      "useServiceAccount": "string",

      "useHostedInfrastructure": true

    }

  },

  "accessNode": {

    "id": 0,

    "name": "string",

    "displayName": "string",

    "type": 0

  },

  "region": {

    "guid": "string",

    "name": "string"

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Cleanroom/Target' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "vendor": "NONE",
  "hypervisor": {
    "entity": {
      "id": 0,
      "name": "string"
    },
    "optionsAzure": {
      "name": "string",
      "skipCredentialValidation": false,
      "accessNodes": [
        {
          "id": 0,
          "name": "string",
          "displayName": "string",
          "type": 0
        }
      ],
      "credentials": {
        "id": 0,
        "name": "string"
      },
      "etcdProtection": {
        "enabled": true,
        "plan": {
          "id": 0,
          "name": "string"
        }
      },
      "planEntity": {
        "id": 0,
        "name": "string"
      },
      "enableCloudConfigProtection": false,
      "workloadType": "string",
      "workloadRegion": {
        "id": 0,
        "name": "string"
      },
      "hypervisorType": "AZURE_V2",
      "useManagedIdentity": false,
      "subscriptionId": "string"
    },
    "optionsAmazon": {
      "name": "string",
      "skipCredentialValidation": false,
      "accessNodes": [
        {
          "id": 0,
          "name": "string",
          "displayName": "string",
          "type": 0
        }
      ],
      "credentials": {
        "id": 0,
        "name": "string"
      },
      "etcdProtection": {
        "enabled": true,
        "plan": {
          "id": 0,
          "name": "string"
        }
      },
      "planEntity": {
        "id": 0,
        "name": "string"
      },
      "enableCloudConfigProtection": false,
      "workloadType": "string",
      "workloadRegion": {
        "id": 0,
        "name": "string"
      },
      "hypervisorType": "Amazon",
      "accessKey": "string",
      "RoleARN": "string",
      "secretKey": "string",
      "Region": "string",
      "useIamRole": true,
      "enableAWSAdminAccount": true,
      "useServiceAccount": "string",
      "useHostedInfrastructure": true
    }
  },
  "accessNode": {
    "id": 0,
    "name": "string",
    "displayName": "string",
    "type": 0
  },
  "region": {
    "guid": "string",
    "name": "string"
  }
}'