Environment

A deployment target within a project where blueprint components become live infrastructure.

Each project can have multiple environments (e.g., staging, production). When you deploy to an environment, every component in the project's blueprint is realized as an Instance -- a running piece of cloud infrastructure with its own configuration, state, and cost data.

Environments inherit tags from their parent project. You can also set environment-scoped tags that cascade down to all instances within the environment. Defaults let you pre-assign resources (like a shared VPC or DNS zone) so that new instances automatically receive them.

Before deleting an environment, all instances must be decommissioned. Use the deletable field to check for blocking constraints.

type Environment {
  id: ID!
  name: String!
  description: String
  tags: Map!
  createdAt: DateTime!
  updatedAt: DateTime!
  project: Project
  cost: CostSummary!
  deletable: Deletable!
  blueprint: EnvironmentBlueprint
  defaults(
    cursor: Cursor
  ): EnvironmentDefaultsPage
}

Fields

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

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

Display name shown in the UI and CLI. Must be unique within the project.

Environment.description ● String scalar {#description}

Free-text description of what this environment is for.

Environment.tags ● Map! non-null scalar {#tags}

Key-value tags assigned directly to this environment. Tags cascade to instances. Must conform to your organization's tag constraints for the ENVIRONMENT scope.

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 parent project that this environment belongs to.

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

Aggregated cloud-provider cost metrics for all instances in this environment.

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

Whether this environment can be safely deleted. Check constraints for blocking conditions.

Environment.blueprint ● EnvironmentBlueprint object {#blueprint}

The realized infrastructure blueprint showing deployed instances and their connections in this environment.

Environment.defaults ● EnvironmentDefaultsPage object {#defaults}

Paginated list of default resources for this environment.

Defaults are pre-assigned resources (like a shared VPC or DNS zone) that instances automatically inherit when they require a matching resource type. Only one default per resource type is allowed.

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

Cursor from a previous page to fetch the next set of results.

Returned By

environment query

Member Of

EnvironmentEvent object ● EnvironmentPayload object ● EnvironmentsPage object ● Instance object