Skip to main content
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
    }
  ]
}
'
{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

The name of the sandbox

Minimum string length: 1
description
string

A description for the sandbox

topics
string[]
Maximum string length: 50
repo
string<uri>

A git repository URL to clone into the sandbox, e.g. a GitHub/Tangled repo.

vcpus
integer
Required range: x >= 1
memory
integer
Required range: x >= 1
disk
integer
Required range: x >= 3
readme
string<uri>

A URI to a README for the sandbox.

secrets
object[]
variables
any[]
files
object
volumes
object[]

Response

OK