Perform VMClient Offboard

Select

SaaS

Customer Managed

This operation offboards a VM client based on GUID of the VM client.

More Details

Path Parameters

• vmGuid string required

application/json

Request Body required

• vmName string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

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

{
  "errorMessage": "Successfully offboarded the vm client HMLMV2RegVM1VM1",
  "errorCode": 0
}

POST /vm/:vmguid/offboard    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

vmGuid — path required

Body required

• Default
• Example

---

{
  "vmName": "HMLMV2RegVM1VM1"
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/VM/:vmGuid/Offboard' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "vmName": "HMLMV2RegVM1VM1"
}'