Retrieves running and saved lab instances available to this API consumer

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

The RunningAndSavedLabs command retrieves all lab instances launched by this API Consumer that are currently running or saved.
NOTE: there are no query parameters for this command.

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

Responses
200

OK Response.

Example of retrieving all lab instances launched by this API Consumer that are currently running or saved
{
  "RunningLabs": [
    {
      "Id": 3497,
      "UserId": "5843",
      "UserFirstName": "John",
      "UserLastName": "Doe",
      "LabProfileId": 5,
      "LabProfileName": "Demo Lab 1",
      "LabProfileNumber": "LAB001",
      "Start": 1338223121,
      "Expires": 1338244721,
      "IsExam": false
    }
  ],
  "SavedLabs": [
    {
      "Id": 3493,
      "UserId": "5158",
      "UserFirstName": "Sally",
      "UserLastName": "Smith",
      "LabProfileId": 1,
      "LabProfileName": "Demo Lab 2",
      "LabProfileNumber": "LAB002",
      "Start": 1337987655,
      "Expires": 1338592455,
      "IsExam": false
    }
  ],
  "Status": 1,
  "Error": null
}
Expand All
object
RunningLabs
Array of object

Array of LabInstance objects for running labs.

object
Id
integer (int64)

The unique identifier of the lab instance.

UserId
string

The ID of the user the lab instance belongs to.

UserFirstName
string

The first name of the user the lab instance belongs to.

UserLastName
string

The last name of the user the lab instance belongs to.

LabProfileId
integer (int32)

The unique identifier of the lab profile the lab instance is based on.

LabProfileName
string

The number/code of the lab profile the lab instance is based on.

LabProfileNumber
string

The name of the lab profile the lab instance is based on.

Start
integer (int64)

When the lab instance was started (in Unix epoch time).

Expires
integer (int64)

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

IsExam
boolean

Indicates whether the lab is scored.

SavedLabs
Array of object

Array of LabInstance objects for saved labs.

object
Id
integer (int64)

The unique identifier of the lab instance.

UserId
string

The ID of the user the lab instance belongs to.

UserFirstName
string

The first name of the user the lab instance belongs to.

UserLastName
string

The last name of the user the lab instance belongs to.

LabProfileId
integer (int32)

The unique identifier of the lab profile the lab instance is based on.

LabProfileName
string

The number/code of the lab profile the lab instance is based on.

LabProfileNumber
string

The name of the lab profile the lab instance is based on.

Start
integer (int64)

When the lab instance was started (in Unix epoch time).

Expires
integer (int64)

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

IsExam
boolean

Indicates whether the lab is scored.

Status
integer (int32)

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.