Skip to main content
GET
Get environment
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

include
enum<string>[]
Available options:
application,
branch,
deployments,
currentDeployment,
primaryDomain,
instances,
database,
cache,
buckets,
websocketApplication,
secrets

Response

EnvironmentResource

data
EnvironmentResource · object
required
included
(ApplicationResource · object | BranchResource · object | DeploymentResource · object | DomainResource · object | InstanceResource · object | DatabaseSchemaResource · object | CacheResource · object | FilesystemResource · object | WebsocketApplicationResource · object | SecretResource · object)[]