List Labs

GET

/tenant/{tenantId}/lab

const url = 'https://api.exolink.cloud/tenant/example/lab';
const options = {
  method: 'GET',
  headers: {
    'x-exo-fields': '["id","displayName"]',
    'x-exo-filter': '["eq","profileId",3]',
    'x-exo-sort': '["asc","displayName"]',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.exolink.cloud/tenant/example/lab \
  --header 'Authorization: Bearer <token>' \
  --header 'x-exo-fields: ["id","displayName"]' \
  --header 'x-exo-filter: ["eq","profileId",3]' \
  --header 'x-exo-sort: ["asc","displayName"]'

Get list of lab environments. Send Content-Type: text/csv to receive CSV.

With x-exo-fields, the computed fields status, health, reason and url are only returned when listed.

Authorizations

bearerToken

Parameters

Path Parameters

tenantId

required

string

Tenant domain prefix

Header Parameters

x-exo-fields

string

JSON array of the fields to return

Example

["id","displayName"]

x-exo-filter

string

JSON filter expression [operator, field, value]. Operators: eq, ne, gt, gte, lt, lte, in, nin, like, ilike, nlike, nilike, null, nnull, and eqc, nec, gtc, gtec, ltc, ltec to compare two fields. Combine expressions with ["and", ...] or ["or", ...].

Example

["eq","profileId",3]

x-exo-page

integer

>= 1

Page number, starting at 1. Applies together with x-exo-size.

x-exo-size

integer

>= 1

Page size. Every returned row then carries __total, the number of matching rows.

x-exo-sort

string

JSON sort [direction, field] with direction asc or desc, or a list of them

Example

["asc","displayName"]

Responses

200

List of labs

Array<object>

Lab environment for testing and development

object

Lab ID

integer

tenantId

Tenant ID

integer

displayName

Lab display name

string

appId

Set when this lab is a hardcoded app rather than a designer-built flow (see GET /tenant/{tenantId}/app). Null for a classic lab.

string

nullable

version

Lab software version

string

tenantSubscriptionId

Associated subscription ID

integer

nullable

cpu

CPU units of the lab

integer

nullable

memory

Memory of the lab in MiB

integer

nullable

health

Lab health status

string

status

Lab status, such as PENDING, RUNNING, STOPPED, PAUSED or DELETED

string

reason

Why the lab is not healthy, if it is not

string

pausedAt

Set while the lab is paused

string format: date-time

nullable

url

Lab access URL

string

createdAt

string format: date-time

updatedAt

string format: date-time

deletedAt

string format: date-time

nullable

Example

[
  {
    "health": "healthy",
    "status": "RUNNING",
    "reason": "Lab is starting up"
  }
]

401

Missing, invalid or expired credentials

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

Allowed values: ERR_API_BAD_REQUEST ERR_API_NOT_AUTHORIZED ERR_API_PAYMENT_REQUIRED ERR_API_FORBIDDEN ERR_API_RESOURCE_NOT_FOUND ERR_API_RESOURCE_IN_USE ERR_API_RESOURCE_ALREADY_EXISTS ERR_API_UNEXPECTED_STATE ERR_API_CONTENT_TOO_LARGE ERR_API_VALIDATION_FAILED ERR_API_VERIFICATION_FAILED ERR_API_NO_TENANT ERR_API_INVALID_INVITATION ERR_API_USER_DISABLED ERR_API_FAILED_DEPENDENCY ERR_EXOLINK_GENERIC

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Not authorized",
  "errorCode": "ERR_API_NOT_AUTHORIZED"
}

403

The caller may not perform this action

application/json

Error response. Some rejections carry only message.

object

message

required

Error message

string

errorCode

Error code

string

details

Failed validations, for requests checked against a schema

Array<object>

object

path

Path of the invalid field

string

message

string

code

string

Example

{
  "message": "Forbidden",
  "errorCode": "ERR_API_FORBIDDEN"
}