component

Fetch a single component by its ID.

Returns null with a NOT_FOUND error if the component does not exist or is not visible to the caller.

query {
  component(organizationId: "my-org", id: "my-project-database") {
    id
    name
    instances {
      items { id environment { id } }
    }
  }
}

component(
  organizationId: ID!
  id: ID!
): Component

Arguments

component.organizationId ● ID! non-null scalar {#organization-id}

Your organization's unique identifier.

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

The component ID to look up (e.g., myproject-database).

Type

Component object

A bundle placed in a project's blueprint, representing a slot for deployable infrastructure.

A component is the design-time building block of your architecture. It says "I want a database here" or "I need a Kubernetes cluster there." The component defines what to deploy; the actual running infrastructure lives in instances -- one per environment the component is deployed to.

Components are connected to each other via links, which declare that one component's output (e.g., a connection string) should be wired into another component's input.