List shared TestCloud environments

get

https://{tenant}.katalon.io/v2/tc/ees/environments

Returns the active shared desktop-browser and mobile-device environments
that support the selected testing type. Omit type to return only
environments that support both automation and manual testing.

A catalog entry is not a reservation and does not guarantee immediate
execution capacity.

The response has an items array with no total and no pagination. It is
built from the first 5,000 matching catalog records, so narrow large
searches with q.

Requires the Execution:Read permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

available

boolean

enum

Defaults to false

Send false or leave it out. Availability filtering is skipped, but
automation availability can still be returned.

Allowed:

includePrivate

boolean

enum

Defaults to false

Send false or leave it out. Returns the shared catalog only.

Allowed:

type

string

enum

Testing type. Omit it to return only environments that support both
automation and manual testing.

Allowed:

string

RSQL filter for shared catalog records. For example,
type==desktop_browser selects desktop browsers and
type==mobile_device selects mobile devices. Only active
environments are returned. URL-encode the expression.

sort

string

Comma-separated catalog field names. Prefix a field with - for
descending order, for example -id. Omit when no
particular order is needed.

Headers

x-account-id

uuid

Account UUID when needed to select the account context.

x-organization-id

int64

Organization ID when needed to select the organization context.

x-project-id

int64

required

Project ID. Required on every request.

Responses

400

A request parameter is invalid.

401

Authentication is missing or invalid.

403

The API key's user does not have the Execution:Read permission in this project.

default

Any other error. The error body can vary.

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

200Shared catalog environments in items.