Resume a lab instance from a saved state

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

The Resume command allows you to resume a specified lab instance.

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 resume.

Example2393049
Responses
200

OK Response.

Example of resuming a lab with a specific lab instance
{
  "Result": 1,
  "Url": "https://labondemand.com/console/setup/1b4909d6-0dbe-43db-9ab9-74ee4f913c4e",
  "Expires": 1337977153,
  "LabProfileId": 18100,
  "Status": 1,
  "Error": null
}
object
Result
integer (int32)

Result of the Resume command. Possible values are:
0 = Error
1 = Success
2 = User has too many active labs
3 = Insufficient host resources
5 = API integration has too many active labs
6 = User has a saved instance of this lab
7 = API integration doesn't have enough available RAM
10 = User doesn't have enough available RAM
20 = User's organization has too many active labs
30 = User's organization doesn't have enough available RAM
40 = Lab profile has too many active instances
50 = Lab organization doesn't have enough available RAM
60 = Lab organization has too many active instances
70 = Lab series has too many active instances
80 = Lab series doesn't have enough available RAM

Url
string

A URL where the lab can be viewed by the user.

LabProfileId
integer (int32)

The Id of the resumed lab profile.

Expires
integer (int64)

When the lab will expire (in Unix epoch time).

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.