Skip to main content

CreateEnvironmentInput

Create a new environment. Environments are isolated deployment contexts like production, staging, or development, each with independent secrets and configurations.

input CreateEnvironmentInput {
  description: String
  id: String!
  name: String!
  tags: Map
}

Fields​

CreateEnvironmentInput.description ● String scalar {#description}​

An optional description of the environment's purpose

CreateEnvironmentInput.id ● String! non-null scalar {#id}​

A short, memorable identifier for looking up this environment in the API and CLI. This becomes the second segment of package identifiers. For example, project 'ecomm' with environment 'prod' and component 'db' creates 'ecomm-prod-db'. Use familiar names like 'prod', 'staging', 'dev'—human-readable, not a UUID. Max 20 characters, lowercase alphanumeric only (a-z, 0-9). Immutable after creation.

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

A human-readable name for the environment

CreateEnvironmentInput.tags ● Map scalar {#tags}​

Key-value tags for this environment. Keys and values must be strings. Must conform to the organization's tag constraints for the environment scope.

Member Of​

createEnvironment mutation