Skip to main content

Project

A project organizes related infrastructure under a single blueprint.

Each project contains a Blueprint that defines your infrastructure architecture -- which bundles to use and how they connect -- and one or more Environments (like staging or production) where that architecture is actually deployed.

Tags set on a project are inherited by all environments and instances within it.

type Project {
  id: ID!
  name: String!
  description: String
  tags: Map!
  createdAt: DateTime!
  updatedAt: DateTime!
  deletable: Deletable!
  cost: CostSummary!
  environments(
    sort: EnvironmentsSort
    cursor: Cursor
  ): EnvironmentsPage
  blueprint: Blueprint
}

Fields​

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

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

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

Project.description ● String scalar {#description}​

Free-text description of what this project is for.

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

Key-value tags assigned directly to this project. Tags cascade to environments and instances. Must conform to your organization's tag constraints for the PROJECT scope.

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

When this project was created (UTC).

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

When this project was last modified (UTC).

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

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

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

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

Project.environments ● EnvironmentsPage object {#environments}​

Paginated list of environments in this project (e.g., staging, production).

Project.environments.sort ● EnvironmentsSort input {#project-environments-sort}​

How to sort results. Defaults to alphabetical by name.

Project.environments.cursor ● Cursor input {#project-environments-cursor}​

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

Project.blueprint ● Blueprint object {#blueprint}​

The infrastructure blueprint defining this project's components and their connections.

Returned By​

project query

Member Of​

Component object ● Environment object ● ProjectEvent object ● ProjectPayload object ● ProjectsPage object