Skip to main content

Modify Virtual Machine Details​

Select

SaaS
Customer Managed

Modify the properties of an existing virtual machine

Path Parameters
  • vmUUID string required

    The vmUUID can be obtained from GET /virtualMachines UUID property

Request Body
  • plan object
  • id int32
  • name string
  • security object
  • associations object[]
  • user object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • useGroup object
  • id int32
  • name string
  • company object
  • id int32
  • name string
  • role object
  • id int32
  • name string
  • permissions object[]
  • permissionId int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag to specify if this is included permission or excluded permission.

  • owners object[]
  • userId int32
  • userName string
  • userGroupId int32
  • userGroupName string
  • requirePasskeyForRestore object

    Model to create, edit or disable passkey

  • currentPassKey string

    The current passkey for restricting backup restores.

  • newPassKey string

    The new passkey for restricting backup restores.

  • confirmPassKey string

    Confirm the new passkey for restricting backup restores.

  • operationType string

    Possible values: [CREATE, DISABLE, EDIT]

    The type of passkey operation

  • authKeyRestore object
  • passKey string

    The existing passkey for restricting backup restores.

  • authOpType boolean

    The type of authorize for restore operation

  • expirationTime int32

    The duration(in unix time) for which a user can continue browsing and restoring backup data without being prompted to enter the passkey, again.

Responses

Success

PUT /v4/virtualmachines/:vmuuid

Authorization

type: apiKeyname: Authtokenin: header

Request

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

  "plan": {

    "id": 0,

    "name": "string"

  },

  "security": {

    "associations": [

      {

        "user": {

          "id": 0,

          "name": "string",

          "company": {

            "id": 0,

            "name": "string"

          }

        },

        "useGroup": {

          "id": 0,

          "name": "string",

          "company": {

            "id": 0,

            "name": "string"

          }

        },

        "role": {

          "id": 0,

          "name": "string"

        }

      }

    ],

    "permissions": [

      {

        "permissionId": 0,

        "permissionName": "string",

        "categoryId": 0,

        "categoryName": "string",

        "type": "ALL_CATEGORIES",

        "exclude": true

      }

    ],

    "owners": [

      {

        "userId": 0,

        "userName": "string",

        "userGroupId": 0,

        "userGroupName": "string"

      }

    ]

  },

  "requirePasskeyForRestore": {

    "currentPassKey": "string",

    "newPassKey": "string",

    "confirmPassKey": "string",

    "operationType": "CREATE"

  },

  "authKeyRestore": {

    "passKey": "string",

    "authOpType": true,

    "expirationTime": 0

  }

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/VirtualMachines/:vmUUID' \
-H 'Content-Type: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "plan": {
    "id": 0,
    "name": "string"
  },
  "security": {
    "associations": [
      {
        "user": {
          "id": 0,
          "name": "string",
          "company": {
            "id": 0,
            "name": "string"
          }
        },
        "useGroup": {
          "id": 0,
          "name": "string",
          "company": {
            "id": 0,
            "name": "string"
          }
        },
        "role": {
          "id": 0,
          "name": "string"
        }
      }
    ],
    "permissions": [
      {
        "permissionId": 0,
        "permissionName": "string",
        "categoryId": 0,
        "categoryName": "string",
        "type": "ALL_CATEGORIES",
        "exclude": true
      }
    ],
    "owners": [
      {
        "userId": 0,
        "userName": "string",
        "userGroupId": 0,
        "userGroupName": "string"
      }
    ]
  },
  "requirePasskeyForRestore": {
    "currentPassKey": "string",
    "newPassKey": "string",
    "confirmPassKey": "string",
    "operationType": "CREATE"
  },
  "authKeyRestore": {
    "passKey": "string",
    "authOpType": true,
    "expirationTime": 0
  }
}'