Cancel a lab instance

  • Updated on Dec 13, 2024
  • 1 minute(s) read
Prev Next
Get
/cancel

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.

Security
API Key
Header parameter nameapi_key

All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".

Query parameters
labinstanceid
integer (int64) Required

The ID of the lab instance to cancel.

Example12345678
Responses
200

OK Response

Example of successfully cancelling a lab instance available to the API consumer

Example of a successful response

{
  "Result": 1,
  "Error": null,
  "Status": 1
}
Example of trying to cancel a lab instance launched by a different API consumer

Example of an error response

{
  "Error": "Invalid integration key",
  "Status": 1
}
object
Result
integer

Indicates the result of the lab instance cancellation.
0 = Error
1 = Success

Status
integer

Indicates the status of the API request.
0 = Error
1 = Success

Error
string | null

In the event of an error, this will contain a detailed error message.