Skip to main content
GET
Get an environment

Authorizations

Authorization
string
header
required

Enforced on every transport, with no exempt operation. A person's request — over the default local unix socket exactly as over a TCP listener — must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011. The socket's file permissions are transport and are not an authorisation.

Path Parameters

environmentId
string
required

The environment's identifier. An environment's identifier, chosen by whoever creates it and unique on this host. It travels as one path segment, so its shape is bounded to what a path segment carries unchanged, exactly as a monitor's name is: a "/" would address no route and a "?" or "#" would end the segment early and address something else.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$

Response

The environment.

A place a session's code lives and its commands run. The host's own machine is not one of these — it is what a session gets by naming none.

id
string
required

An environment's identifier, chosen by whoever creates it and unique on this host. It travels as one path segment, so its shape is bounded to what a path segment carries unchanged, exactly as a monitor's name is: a "/" would address no route and a "?" or "#" would end the segment early and address something else.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
state
enum<string>
required

Whether an environment is answering, and — when it is not — whether waiting is the right move. The distinction is the whole point: a session waiting on an unreachable environment looks identical to a slow one otherwise, and what the person does next depends entirely on which it is. ready — answering; work proceeds. degraded — not answering right now and expected back (restarting, a dropped connection); the host retries and the next call may simply succeed. gone — destroyed, or the runtime no longer has it; nothing brings it back and a session bound to it needs a new one. unusable — its setup did not succeed; setup says what happened.

Available options:
ready,
degraded,
gone,
unusable
image
string
required

The immutable digest of the image this environment actually runs, pinned when it was created and never floated afterwards. Reconnecting after a host restart, and replacing an environment that was lost, both ask for this digest again, so an environment that worked yesterday is the same environment today. There is one official image, which is why nothing supplies this on creation.

Maximum string length: 512
createdAt
string<date-time>
required
setup
object

What the setup script did, absent when none was supplied.