Update a computer environment

Edit an environment’s name and/or Dockerfile. Re-build it for the changes to take effect on a computer. Guest callers are denied (a write).

PATCH /projects/{projectId}/computer-environments/{environmentId}

Update a computer environment

cURL

curl --request PATCH \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "scraper (v2)"
}
'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}"

payload = { "name": "scraper (v2)" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'scraper (v2)'})
};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'scraper (v2)'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}"

	payload := strings.NewReader("{\n  \"name\": \"scraper (v2)\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"scraper (v2)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/computer-environments/{environmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"scraper (v2)\"\n}"

response = http.request(request)
puts response.read_body

200

Example

{ "id": "<string>", "projectId": "<string>", "name": "<string>", "dockerfile": "<string>", "contentHash": "<string>", "isOwner": true, "currentBuild": { "id": "<string>", "baseImageDigests": [ "<string>" ], "createdAt": 123, "e2bBuildId": "<string>", "logPreview": "<string>", "error": "<string>", "startedAt": 123, "finishedAt": 123 }, "createdAt": 123, "updatedAt": 123 }

Authorizations

Authorization · string · header · required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Path Parameters

projectId · string · required

ID of the hosted project that contains the server.

environmentId · string · required

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

Body

application/json

Option 1

Option 2

Edit an environment. Provide at least one of name or dockerfile; only the fields you pass change.

name · string · required

New display name; must be non-empty after trimming.

Minimum string length: 1

dockerfile · string

Replacement Dockerfile text.

Minimum string length: 1

Response

200

application/json

The updated environment.

A project's custom Computer image: a digest-pinned Dockerfile plus its latest build.

id · string · required

projectId · string · required

name · string · required

dockerfile · string · required

contentHash · string · required

sharing · enum<string> · required

user = a personal draft; project = shared with the whole project.

Available options: user, project

isOwner · boolean · required

currentBuild · object | null · required

One build of an environment's image.

Show child attributes

createdAt · number · required

updatedAt · number · required