Environments

Restore an archived environment

Restore an archived environment. Returns 409 if another live environment took its name in the meantime. Plugin pins whose version row no longer exists at all are dropped on the way back to live — compare the returned pluginVersionIds against what you archived to detect that. 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.

POST

projects

{projectId}

environments

{environmentId}

restore

Restore an archived environment

curl --request POST \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedRevision": 1
}
'

import requests

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

payload = { "expectedRevision": 1 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore', 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}/environments/{environmentId}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expectedRevision' => 1
  ]),
  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}/environments/{environmentId}/restore"

	payload := strings.NewReader("{\n  \"expectedRevision\": 1\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedRevision\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "hostId": "<string>",
  "revision": 123,
  "archived": true,
  "createdAt": 123,
  "updatedAt": 123,
  "description": "<string>",
  "serverAttachmentId": "<string>",
  "skillSelection": {
    "mode": "explicit",
    "skillIds": [
      "<string>"
    ]
  },
  "pluginVersionIds": [
    "<string>"
  ],
  "archivedAt": 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

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

Body

application/json

The optimistic-concurrency precondition. Unknown fields are rejected.

expectedRevision

integer

required

The revision you last read for this environment.

Required range: x >= 0

Response

The updated environment.

A project environment: a named, live-editable execution bundle that eval suites and journeys run against.

string

required

projectId

string

required

name

string

required

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

hostId

string

required

The host this environment runs against.

revision

integer

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.

archived

boolean

required

Archived environments cannot be edited or launched until restored.

createdAt

number

required

Unix epoch milliseconds.

updatedAt

number

required

Unix epoch milliseconds.

description

string

serverAttachmentId

string

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

skillSelection

object

An explicit pinned skill selection. Cannot be empty — clear the field instead (send null on update) to mean "no pinned skills".

Show child attributes

pluginVersionIds

string[]

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.

archivedAt

number

Unix epoch milliseconds. Present only when archived.

Archive an environmentArchive an environment. It stops being selectable for runs and frees its name for a new one, but the row is kept and can be restored — this is why archive is a sub-action rather than a DELETE. 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.

⌘I

Restore an archived environment

curl --request POST \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedRevision": 1
}
'

import requests

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

payload = { "expectedRevision": 1 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore', 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}/environments/{environmentId}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expectedRevision' => 1
  ]),
  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}/environments/{environmentId}/restore"

	payload := strings.NewReader("{\n  \"expectedRevision\": 1\n}")

	req, _ := http.NewRequest("POST", 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.post("https://app.mcpjam.com/api/v1/projects/{projectId}/environments/{environmentId}/restore")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedRevision\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "hostId": "<string>",
  "revision": 123,
  "archived": true,
  "createdAt": 123,
  "updatedAt": 123,
  "description": "<string>",
  "serverAttachmentId": "<string>",
  "skillSelection": {
    "mode": "explicit",
    "skillIds": [
      "<string>"
    ]
  },
  "pluginVersionIds": [
    "<string>"
  ],
  "archivedAt": 123
}

API Guides

Endpoints

Restore an archived environment

Authorizations

Path Parameters

Body

Response