Get environment status
Reports what the environment runs now, per region and per revision. Use it to tell whether the current revision’s rollout is complete, and which revisions still have instances that take sessions. Poll this route to follow a rollout.
The status is computed on each read from cluster reports, which can lag by about a minute,
and by up to 15 minutes when a cluster stops reporting. observed_at gives the age. An
unreadable region does not fail the read; it reports state unknown. Treat any state value
you do not recognize as unknown.
Region states: ready (the current revision has its requested instances available and no
older instance is left), deploying (instances are being added or drained), pending (no
instance of the current revision yet), and unknown. The response has
Cache-Control: no-store. Requires the read access of the environment.
Authorizations
A Reactor API key (rk_...), sent as Authorization: Bearer rk_.... Keep it on a server.
Path Parameters
The project's ID, a UUID. It is not the model's ID.
The environment's ID (a UUID) or its name, such as production. A name matches only a live environment; a deleted environment is reachable by its ID only.
Response
The environment's status. Before the first revision, revision is null and regions is empty.