Skip to main content

Edit cleanroom target​

Select

SaaS
Customer Managed

Edit cleanroom target for automation of resources

Request Body
  • general object
  • target object
  • id int32

    Target id

  • name string

    Target name

  • vendor string

    Possible values: [NONE, AZURE_V2, AMAZON]

    Target vendor

  • applicationType string

    Possible values: [NONE, CLEAN_ROOM]

    Target application type

  • hypervisor object
  • id int32

    Hypervisor id

  • name string

    Hypervisor name

  • displayName string

    Hypervisor display name

  • instanceId int32

    Hypervisor instance id

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

    Possible values: [Client, Group, Automatic]

    Target application type

  • security object
  • users object[]

    Users that have access to the target

  • id int32
  • name string
  • fullName string
  • userGroups object[]

    User groups that have access to the target

  • id int32
  • name string
  • entityDisplayName object

    Prefix or Suffix appended to create display name for destination instance

  • prefix string

    A prefix string that will be appended to the source VM to create a display name for each destination VM

  • suffix string

    A suffix string that will be appended to the source VM to create a display name for each destination VM

  • recovery object
  • resourceGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • region object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • storageAccount object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • availabilityZone object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • storageType object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • virtualNetwork object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • vmSize object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • createPublicIPAddress boolean
  • infrastructure object
  • maxNoOfAccessNodes int32
  • networkSettings object
  • virtualNetwork object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • securityGroup object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • createPublicIPAddress boolean
  • advancedSettings object
  • serverGroup object
  • id int32
  • name string
  • type string
  • vmSize object
  • guid string
  • name string
  • type string

    Possible values: [CREATE_NEW, NONE, AUTOMATIC, ORIGINAL, CUSTOM]

  • customImages object[]
  • imageName string
  • operatingSystem string

    Possible values: [UNIX, WINDOWS]

  • advanced object
  • networkAddressSpace object
  • virtualNetwork string
  • recoveredEntity string
  • infrastructure string
  • bastion string
  • securityGroupRules object
  • recoveredEntity object[]
  • priority int32
  • name string
  • sourceIPRange string
  • sourcePortRange string
  • destinationIPRange string
  • destinationPortRange string
  • infrastructure object[]
  • priority int32
  • name string
  • sourceIPRange string
  • sourcePortRange string
  • destinationIPRange string
  • destinationPortRange string
Responses

Success

Schema
  • id int32
  • name string
PUT /cleanroom/target/:id

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "general": {

    "target": {

      "id": 0,

      "name": "string",

      "vendor": "NONE",

      "applicationType": "NONE"

    },

    "hypervisor": {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "instanceId": 0

    },

    "accessNode": {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "type": "Client"

    },

    "security": {

      "users": [

        {

          "id": 0,

          "name": "string",

          "fullName": "string"

        }

      ],

      "userGroups": [

        {

          "id": 0,

          "name": "string"

        }

      ]

    },

    "entityDisplayName": {

      "prefix": "string",

      "suffix": "string"

    }

  },

  "recovery": {

    "resourceGroup": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "region": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "storageAccount": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "availabilityZone": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "storageType": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "virtualNetwork": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "securityGroup": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "vmSize": {

      "guid": "string",

      "name": "string",

      "type": "CREATE_NEW"

    },

    "createPublicIPAddress": true

  },

  "infrastructure": {

    "maxNoOfAccessNodes": 0,

    "networkSettings": {

      "virtualNetwork": {

        "guid": "string",

        "name": "string",

        "type": "CREATE_NEW"

      },

      "securityGroup": {

        "guid": "string",

        "name": "string",

        "type": "CREATE_NEW"

      },

      "createPublicIPAddress": true

    },

    "advancedSettings": {

      "serverGroup": {

        "id": 0,

        "name": "string",

        "type": "string"

      },

      "vmSize": {

        "guid": "string",

        "name": "string",

        "type": "CREATE_NEW"

      },

      "customImages": [

        {

          "imageName": "string",

          "operatingSystem": "UNIX"

        }

      ]

    }

  },

  "advanced": {

    "networkAddressSpace": {

      "virtualNetwork": "string",

      "recoveredEntity": "string",

      "infrastructure": "string",

      "bastion": "string"

    },

    "securityGroupRules": {

      "recoveredEntity": [

        {

          "priority": 0,

          "name": "string",

          "sourceIPRange": "string",

          "sourcePortRange": "string",

          "destinationIPRange": "string",

          "destinationPortRange": "string"

        }

      ],

      "infrastructure": [

        {

          "priority": 0,

          "name": "string",

          "sourceIPRange": "string",

          "sourcePortRange": "string",

          "destinationIPRange": "string",

          "destinationPortRange": "string"

        }

      ]

    }

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Cleanroom/Target/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "general": {
    "target": {
      "id": 0,
      "name": "string",
      "vendor": "NONE",
      "applicationType": "NONE"
    },
    "hypervisor": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "instanceId": 0
    },
    "accessNode": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "type": "Client"
    },
    "security": {
      "users": [
        {
          "id": 0,
          "name": "string",
          "fullName": "string"
        }
      ],
      "userGroups": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    },
    "entityDisplayName": {
      "prefix": "string",
      "suffix": "string"
    }
  },
  "recovery": {
    "resourceGroup": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "region": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "storageAccount": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "availabilityZone": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "storageType": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "virtualNetwork": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "securityGroup": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "vmSize": {
      "guid": "string",
      "name": "string",
      "type": "CREATE_NEW"
    },
    "createPublicIPAddress": true
  },
  "infrastructure": {
    "maxNoOfAccessNodes": 0,
    "networkSettings": {
      "virtualNetwork": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "securityGroup": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "createPublicIPAddress": true
    },
    "advancedSettings": {
      "serverGroup": {
        "id": 0,
        "name": "string",
        "type": "string"
      },
      "vmSize": {
        "guid": "string",
        "name": "string",
        "type": "CREATE_NEW"
      },
      "customImages": [
        {
          "imageName": "string",
          "operatingSystem": "UNIX"
        }
      ]
    }
  },
  "advanced": {
    "networkAddressSpace": {
      "virtualNetwork": "string",
      "recoveredEntity": "string",
      "infrastructure": "string",
      "bastion": "string"
    },
    "securityGroupRules": {
      "recoveredEntity": [
        {
          "priority": 0,
          "name": "string",
          "sourceIPRange": "string",
          "sourcePortRange": "string",
          "destinationIPRange": "string",
          "destinationPortRange": "string"
        }
      ],
      "infrastructure": [
        {
          "priority": 0,
          "name": "string",
          "sourceIPRange": "string",
          "sourcePortRange": "string",
          "destinationIPRange": "string",
          "destinationPortRange": "string"
        }
      ]
    }
  }
}'