networks

Let your sandboxes reach each other by name, or stop them.

Needs a kept top-up, and free. When on, a program in any of your sandboxes connects to another of your sandboxes at <name>.sandbox.internal:<port> (the name it was created with) or <id>.sandbox.internal:<port>, over TCP, on any port but 10800, 10802 and 10853, which Runtime uses inside every sandbox. A paused sandbox wakes when a connection reaches it. Only your organization's sandboxes answer; nothing else, inside Runtime or out, can reach them this way. Off by default. Turning it off cuts open connections between your sandboxes within seconds.

put/v1/networks/private

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/networks/private
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Request body

enabledboolean required

true: your sandboxes reach each other by name. false: they stop, and open connections between them are cut within seconds.

Response

Success

enabledboolean required

Whether your sandboxes reach each other by name now.

suffix'sandbox.internal' required

Reach a sandbox at <name>.sandbox.internal or <id>.sandbox.internal.

allowedboolean required

Whether this account may turn it on: it must have a kept top-up.

whystring nullable required

Why it may not, when allowed is false: not_paid, revoked or suspended.

enabledAtstring nullable required

When it was last turned on.

disabledAtstring nullable required

When it was last turned off.

Changes

No recorded changes to this operation across all 1 revision of this API.