Skip to main content
GET
List instances
Required permission: environment.view

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

environment
string
required

The environment identifier

Query Parameters

filter[name]
string
filter[type]
string
filter[size]
string
filter[scaling_type]
string
include
enum<string>[]
Available options:
environment,
backgroundProcesses,
scheduledCommands

Response

Paginated set of InstanceResource

data
InstanceResource · object[]
required
meta
object
required
included
(EnvironmentResource · object | BackgroundProcessResource · object | ScheduledCommandResource · object)[]