Update sandbox settings
curl --request POST \
--url https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"topics": [
"<string>"
],
"repo": "<string>",
"vcpus": 2,
"memory": 2,
"disk": 4,
"readme": "<string>",
"secrets": [
{
"name": "<string>",
"value": "<string>",
"sandboxId": "<string>"
}
],
"variables": [
"<unknown>"
],
"volumes": [
{
"name": "<string>",
"sandboxId": "<string>",
"path": "<string>",
"readOnly": true
}
]
}
'import requests
url = "https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings"
payload = {
"name": "<string>",
"description": "<string>",
"topics": ["<string>"],
"repo": "<string>",
"vcpus": 2,
"memory": 2,
"disk": 4,
"readme": "<string>",
"secrets": [
{
"name": "<string>",
"value": "<string>",
"sandboxId": "<string>"
}
],
"variables": ["<unknown>"],
"volumes": [
{
"name": "<string>",
"sandboxId": "<string>",
"path": "<string>",
"readOnly": True
}
]
}
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({
name: '<string>',
description: '<string>',
topics: ['<string>'],
repo: '<string>',
vcpus: 2,
memory: 2,
disk: 4,
readme: '<string>',
secrets: [{name: '<string>', value: '<string>', sandboxId: '<string>'}],
variables: ['<unknown>'],
volumes: [{name: '<string>', sandboxId: '<string>', path: '<string>', readOnly: true}]
})
};
fetch('https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings', 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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings",
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([
'name' => '<string>',
'description' => '<string>',
'topics' => [
'<string>'
],
'repo' => '<string>',
'vcpus' => 2,
'memory' => 2,
'disk' => 4,
'readme' => '<string>',
'secrets' => [
[
'name' => '<string>',
'value' => '<string>',
'sandboxId' => '<string>'
]
],
'variables' => [
'<unknown>'
],
'volumes' => [
[
'name' => '<string>',
'sandboxId' => '<string>',
'path' => '<string>',
'readOnly' => true
]
]
]),
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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>"
}{
"error": "<unknown>",
"message": "<string>"
}Sandboxes
Update Settings
POST
/
io.pocketenv.sandbox.updateSandboxSettings
Update sandbox settings
curl --request POST \
--url https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"topics": [
"<string>"
],
"repo": "<string>",
"vcpus": 2,
"memory": 2,
"disk": 4,
"readme": "<string>",
"secrets": [
{
"name": "<string>",
"value": "<string>",
"sandboxId": "<string>"
}
],
"variables": [
"<unknown>"
],
"volumes": [
{
"name": "<string>",
"sandboxId": "<string>",
"path": "<string>",
"readOnly": true
}
]
}
'import requests
url = "https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings"
payload = {
"name": "<string>",
"description": "<string>",
"topics": ["<string>"],
"repo": "<string>",
"vcpus": 2,
"memory": 2,
"disk": 4,
"readme": "<string>",
"secrets": [
{
"name": "<string>",
"value": "<string>",
"sandboxId": "<string>"
}
],
"variables": ["<unknown>"],
"volumes": [
{
"name": "<string>",
"sandboxId": "<string>",
"path": "<string>",
"readOnly": True
}
]
}
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({
name: '<string>',
description: '<string>',
topics: ['<string>'],
repo: '<string>',
vcpus: 2,
memory: 2,
disk: 4,
readme: '<string>',
secrets: [{name: '<string>', value: '<string>', sandboxId: '<string>'}],
variables: ['<unknown>'],
volumes: [{name: '<string>', sandboxId: '<string>', path: '<string>', readOnly: true}]
})
};
fetch('https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings', 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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings",
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([
'name' => '<string>',
'description' => '<string>',
'topics' => [
'<string>'
],
'repo' => '<string>',
'vcpus' => 2,
'memory' => 2,
'disk' => 4,
'readme' => '<string>',
'secrets' => [
[
'name' => '<string>',
'value' => '<string>',
'sandboxId' => '<string>'
]
],
'variables' => [
'<unknown>'
],
'volumes' => [
[
'name' => '<string>',
'sandboxId' => '<string>',
'path' => '<string>',
'readOnly' => true
]
]
]),
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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\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://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pocketenv.io/xrpc/io.pocketenv.sandbox.updateSandboxSettings")
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 \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"topics\": [\n \"<string>\"\n ],\n \"repo\": \"<string>\",\n \"vcpus\": 2,\n \"memory\": 2,\n \"disk\": 4,\n \"readme\": \"<string>\",\n \"secrets\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"sandboxId\": \"<string>\"\n }\n ],\n \"variables\": [\n \"<unknown>\"\n ],\n \"volumes\": [\n {\n \"name\": \"<string>\",\n \"sandboxId\": \"<string>\",\n \"path\": \"<string>\",\n \"readOnly\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>"
}{
"error": "<unknown>",
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The name of the sandbox
Minimum string length:
1A description for the sandbox
Maximum string length:
50A git repository URL to clone into the sandbox, e.g. a GitHub/Tangled repo.
Required range:
x >= 1Required range:
x >= 1Required range:
x >= 3A URI to a README for the sandbox.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
OK
Was this page helpful?
⌘I
