Docs
Console

Join a network

MarkdownChatGPTClaude

Preview. Make a running sandbox a member of a network of its workspace. It gets an address in the network at once, and the other members resolve its name within seconds. A member joins again as it is.

POST
/sandboxes/{sandbox_id}/networks/{network_id}

Authorization

headerAuthorizationBearer <token>

Your Munito API key.

Path Parameters

sandbox_id*string

The id of the sandbox.

network_id*string

The id of the network.

Response Body

The sandbox, with its address in the network.

application/json
  1. response
id*string
object?string
Default"sandbox"
status*SandboxStatus

pending until it runs, then running, then stopped. failed when it did not start. A persistent sandbox is paused between a pause and a resume, and pending while it resumes.

Value in"pending""running""paused""stopped""failed"
template*string
size*string

The preset, or custom.

vcpus*integer
memory_mib*integer
disk_gib*integer

The root disk in GiB.

internet*boolean
persistent*boolean

The sandbox keeps its files and its processes across a pause.

metadata*
created_at*integer

Unix seconds.

started_at*|

Unix seconds, or null before the sandbox runs.

expires_at*integer

Unix seconds. The sandbox stops then, or pauses when it is persistent.

ended_at*|

Unix seconds, or null while the sandbox runs.

end_reason*|

deleted, timeout or error, or null while the sandbox runs.

public_ports?array<integer>

The ports that open without the sandbox's token.

ssh_keys?array<string>

The public keys that open SSH to the sandbox.

hostname?|

The name of the sandbox in its networks, or null for its id.

networks?array<>

The networks that the sandbox is a member of.

curl -X POST 'https://api.munito.ai/sandboxes/v1/sandboxes/string/networks/string'
Example Response
{
  "id": "string",
  "object": "sandbox",
  "status": "pending",
  "template": "string",
  "size": "string",
  "vcpus": 0,
  "memory_mib": 0,
  "disk_gib": 0,
  "internet": true,
  "persistent": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "created_at": 0,
  "started_at": 0,
  "expires_at": 0,
  "ended_at": 0,
  "end_reason": "deleted",
  "public_ports": [
    0
  ],
  "ssh_keys": [
    "string"
  ],
  "hostname": "string",
  "networks": [
    {
      "id": "string",
      "name": "string",
      "dns_name": "string",
      "address": "string"
    }
  ]
}

Create SSH access POST

Preview. A user name that opens SSH to the sandbox on its own, until it expires. It needs no key in the sandbox, so it is the whole credential: keep it secret.

Leave a network DELETE

Preview. Take a sandbox out of a network. It loses its address there, and reaches no member of it any more.