Environments

Update an environment

Changed on Oct 4, 2026

Edit an environment. Only the fields you send change; send null for serverAttachmentId, skillSelection, or pluginVersionIds to clear them. Requires expectedRevision — the revision you last read. If the environment changed since, the write is rejected with 409 rather than overwriting the concurrent edit. Requires project admin.

patch/projects/{projectId}/environments/{environmentId}

Request

Base URL
https://app.mcpjam.com/api/v1
URL
https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}
Auth
HTTP bearer

Path parameters

projectIdstring required

ID of the hosted project that contains the server.

environmentIdstring required

Project environment ID, as returned by the project's environment list.

Request body

expectedRevisioninteger required

The revision you last read. If the environment changed since, the write is rejected with 409 rather than clobbering the other edit.

namestring

descriptionstring

Send an empty string to clear the description.

hostIdstring

serverAttachmentIdstring nullable

null clears the pin and falls back to the host config's servers.

modelIdstring nullable

New model override, or null to CLEAR it and fall back to the host's model. Omit to leave unchanged. An empty string is rejected — it is not a way to clear.

pluginVersionIdsstring[] nullable

Pinned plugin VERSION IDs. Narrow by design: the plugin must be installed and enabled, the version must be ready, at most one version per plugin may be pinned, and none of its skills may carry supporting files. Not a general-purpose plugin list. null clears all pins.

sandboxImageIdstring nullable

New sandbox-image pin, or null to clear it. Omit to leave unchanged.

Response

The updated environment.

idstring required

projectIdstring required

namestring required

Unique among the project's live (non-archived) environments.

descriptionstring

hostIdstring required

The host this environment runs against.

serverAttachmentIdstring

Present only when the environment pins a standalone server group; otherwise the host config's own servers apply.

modelIdstring

The environment's model override. ABSENT means the environment INHERITS the model pinned on its host — not that it has no model. Resolve the environment and read effectiveModelId to learn what will actually run. COMPUTED in responses: the selection's modelId when there is one, else the stored bare id. Accepted on writes as a shorthand: send a bare id and the platform converts it (a hosted id becomes a hosted selection, any other a LegacyModelSelection).

modelSelectionOrigin'backfill'

backfill when a conversion (a save of a bare id, or the old-data backfill) chose modelSelection rather than a person. Absent when a person chose it, and on rows with no selection.

pluginVersionIdsstring[]

sandboxImageIdstring

Sandbox-image pin: a project-shared image (see the images endpoints) that eval runs in this environment boot a fresh sandbox from. Absent when unpinned.

revisioninteger required

Optimistic-concurrency counter. Pass this back as expectedRevision on the next write; if it no longer matches, the write is rejected with 409 instead of overwriting a concurrent edit.

archivedboolean required

Archived environments cannot be edited or launched until restored.

archivedAtnumber

Unix epoch milliseconds. Present only when archived.

createdAtnumber required

Unix epoch milliseconds.

updatedAtnumber required