Reference · the tools · environments

Stop an environment

What it does

Stop an environment: its stop script runs if it has one, then its containers come down. Every byte of data stays, and so do its address and port; it stops counting against the cap. start_environment brings it back. (formerly stop_bundle)

What it needs to know

environment_id

The environment.

box · optional

Which box: its name and account, "home.frank" or "jordan.northwind", or just "home" when only one of your boxes is called that. Omit it for your current box (switch_box changes it; list_boxes says which it is).

session_box · optional

The box this session runs on, if it runs on one of yours: its name, as the on-box instructions give it ("frankh90.hemlane"). With it, a call that names no box is checked against your current box.

Where it lands

On one of your boxes: the one named in box, or your default box when none is named.