Skip to main content
PUT
Replace an environment

Authorizations

Authorization
string
header
required

A Reactor API key (rk_...), sent as Authorization: Bearer rk_.... Keep it on a server.

Headers

If-Match
string

The ETag of your last read, a revision number in quotes. If the environment's newest revision differs, the write is 412 etag_mismatch and nothing is written. A weak tag, a list, or * is 400.

Example:

"\"3\""

Path Parameters

proj_id
string<uuid>
required

The project's ID, a UUID. It is not the model's ID.

env
string
required

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.

Body

application/json

The full desired settings. Read-only fields are accepted only with their current values.

image
object
required

The image to run. Send tag, ref, both (they must name the same image), or digest alone. A tag is a model image tag, or a release of the model; a tag wins over a release of the same name. A 12 to 64 character lowercase hex tag that no tag has names the image whose digest it starts. A digest is sha256:<64 hex> or a 12+ character hex prefix. A ref, a digest, or such a hex tag runs the image with no release.

instances
object[]
required
weights
string | null

As on the update. Omitted keeps the current pin; null clears it.

resources
object

A full object. An omitted accelerators is [] (CPU); an omitted cpu or memory value is unset.

extra_args
string[]
variables
object

The full map. An omitted name is removed.

deployment_strategy
enum<string>
default:ROLLING
Available options:
ROLLING,
REPLACE_ALL
interrupt_sessions
boolean
default:false

Response

The environment after the write.

id
string<uuid>
required

The environment's ID. It is neither the project's nor the model's ID.

project_id
string<uuid>
required
name
string
required
image
object | null
required

The current image. For production, the deployed release's image. Null for another environment before its first revision.

weights
object | null
required

The pinned weights. Null when none are pinned.

resources
object
required

What each instance gets.

extra_args
string[]
required

Extra arguments passed to the model container.

node_selector
string | null
required

Read-only.

instances
object[]
required
revision
object | null
required

The current revision. Null before the first revision.

public
boolean
required

When true, any authenticated caller can open sessions on production. It grants no read. Read-only for customers.

created_at
string<date-time>
required
deleted_at
string<date-time> | null
required

When the environment was deleted. A deleted environment takes no writes.

variables
object

Variables keyed by name. Names use letters, digits, _, -, and ., with no leading digit. Reserved names such as MODEL_NAME and any REACTOR_ name are refused.