Returns a single use URL is used to access a lab instance

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

The LabAccessUrl command returns a single use URL to access 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.

roleId
integer (int32)

Allows you to specify the role(s) to assign to the user. You may pass multiple instances of this parameter to specify multiple roles. Roles are used for specialized integration purposes and are not needed in typical integration scenarios. Role IDs will be provided by Skillable when appropriate.

Responses
200

OK Response.

Example of successfully retrieving the URL for an active Lab instance.
{
  "Url": "https://labondemand.com/access/ab1c2345-6d7b-890e-f1gh-234ij5kl6m7n",
  "Error": null,
  "Status": 1
}
object
Url
string

The single use URL to access the 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