networks

Add one of your machines or routers to the private network, and get its wg-quick file.

Send your peer's public key, or leave it out and Runtime generates the pair and puts the private key in config once. routes are your own ranges behind the peer that sandboxes may reach. At most 16 peers.

post/v1/networks/wireguard/peers

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/networks/wireguard/peers
  • 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

namestring required

Your own handle for the resource. Letters, digits, dot, dash, underscore.

publicKeystring

The peer's WireGuard public key. Leave it out and Runtime generates the pair.

routesstring[]

Private IPv4 ranges on your side of this peer that sandboxes may reach, such as 10.0.0.0/16.

Response

Success

configstring nullable

A wg-quick file or a draft when configReady is false. Keep it: a Runtime-generated private key is delivered here once. Complete the gateway PublicKey before using a draft.

configReadyboolean

Whether config includes the gateway public key. Funding and access are reported separately on tunnel.

hintstring

Changes

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