Cancel a lab instance

The Cancel command allows you to cancel a specified lab instance.

Please note: when issuing this command that there is some time required for the lab instance tear down process. If retrying a lab launch for a user where the Max Active Lab Instances Per User is set to 1 for the API consumer, then please take this teardown time into account for the API integration.

Securityapi_key
Request
query Parameters
labinstanceid
required
integer <int64>

The ID of the lab instance to cancel.

Example: labinstanceid=12345678
Responses
200

OK Response

get/cancel
Request samples 
Response samples 
application/json
{
  • "Result": 1,
  • "Error": null,
  • "Status": 1
}