Returns a single use URL to monitor a lab instance

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

The LabMonitorUrl command returns a single use URL to monitor a 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 unique identifier of the lab instance.

Responses
200

OK Response.

Example of successfully retrieving the URL to monitor a lab instance
{
  "Url": "https://labondemand.com/access/ab1c2345-6d7b-890e-f1gh-234ij5kl6m7n?monitor=1",
  "Error": null,
  "Status": 1
}
object
Url
string

The single use URL to monitor a lab instance

Error
string | null

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

Status
integer (int32)

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