Environment

An environment with its full details and related resources.

type Environment {
  id: ID!
  name: String!
  description: String
  createdAt: DateTime!
  updatedAt: DateTime!
  project: Project
  cost: CostSummary!
  deletable: Deletable!
  instances(
    filter: InstancesFilter
    sort: InstancesSort
    cursor: Cursor
  ): InstancesPage
}

Fields

Environment.id ● ID! non-null scalar {#id}

Environment.name ● String! non-null scalar {#name}

Display name

Environment.description ● String scalar {#description}

What this environment is for

Environment.createdAt ● DateTime! non-null scalar {#created-at}

When this environment was created (UTC)

Environment.updatedAt ● DateTime! non-null scalar {#updated-at}

When this environment was last modified (UTC)

Environment.project ● Project object {#project}

The project containing this environment.

Environment.cost ● CostSummary! non-null object {#cost}

Cloud provider costs for this environment.

Environment.deletable ● Deletable! non-null object {#deletable}

Whether this environment can be deleted and any constraints preventing deletion.

Environment.instances ● InstancesPage object {#instances}

The instances deployed in this environment.

Environment.instances.filter ● InstancesFilter input {#environment-instances-filter}

Filter results (projectId and environmentId are ignored — already scoped by parent)

Environment.instances.sort ● InstancesSort input {#environment-instances-sort}

Environment.instances.cursor ● Cursor input {#environment-instances-cursor}

Returned By

environment query

Member Of

EnvironmentPayload object ● Instance object