blossom environment:update

cli reference 2 min read

Update an environment

Usage

blossom environment:update --id ID [--data DATA]

Flags

Flag	Description
`--id (required)`	Environment id
`--data, -d`	YAML or JSON data, a path to a data file, or an HTTP(S) URL

Examples:

blossom environment:update --id environment-100 --data environment.yml
blossom environment:update --id environment-100 -d '{"environment":{"image_repo":"registry.example.com/demo"}}'

environment.yml:

environment:
  image_repo: registry.example.com/demo

Updates an environment. --id identifies the existing environment. Do not put the id inside the payload.

Changes that affect the next deployment appear in environment:pending_changes:show until a deployment includes them. Health checks belong to Services and are changed with service:update.

Automatic deploys

Deploy on pushes to the Environment’s configured branch:

blossom environment:update --id environment-100 -d '{"environment":{"automatic_deploys":true}}'

Requires a repository connected through a Git provider. Blossom registers the provider webhook; enabling this setting does not start a deployment. Use false to disable automatic deploys. Preview triggers keep their webhook when needed. If webhook registration fails, automatic deploys remain off and the command reports the error.

Access:

environment:
  access_mode: members        # public, password or members
  preview_access: members     # members, or same to match this Environment
  access_public_paths:
    - /webhooks/*

access_mode sets who can open the Environment’s URLs: anyone, people with the basic auth password, or people signed in to Blossom who can view the Environment. access_public_paths lists paths, or prefixes ending in *, that skip the Account members sign-in, such as webhook endpoints. Access changes apply within about 30 seconds and sign everyone out when the mode changes.