networks

Give a peer a new key. The old key stops working within seconds.

post/v1/networks/wireguard/peers/{id}:rotate

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/networks/wireguard/peers/{id}:rotate
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

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

publicKeystring

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

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.