Perform virtual machine operations

Select

SaaS

Customer Managed

Perform VM operations for entties in a Recovery Group

Path Parameters

• VirtualMachineOperation VirtualMachineOperationEnum required

  Possible values: [POWER_OFF = 0, POWER_ON = 1]

application/json

Request Body

VM operation request body

• recoveryGroupId int32

  Id of the recovery group

• recoveryGroupName string required

  Name of the recovery group

• sourceVMs object[]

  guid string

  name string

Responses

• 200
• 400
• 404
• 500

---

OK

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]

  Error code value

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

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]

  Error code value

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

Not Found

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]

  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]

  Error code value

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

POST /v4/recoverygroup/vm/:virtualmachineoperation    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

VirtualMachineOperation — path required

---POWER_OFF = 0POWER_ON = 1

Body

{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/RecoveryGroup/VM/:VirtualMachineOperation' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "recoveryGroupId": 0,
  "recoveryGroupName": "string",
  "sourceVMs": [
    {
      "guid": "string",
      "name": "string"
    }
  ]
}'