networks

Remove a peer. Its tunnel and connections end within seconds.

delete/v1/networks/wireguard/peers/{id}

Request

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

Response

Success

fundedboolean

Funding permits traffic. False disables traffic while retaining the reservation; check balance, spending limits and account permissions.

fundedUntilstring date-time nullable

Last funded-through timestamp, possibly in the past. Null means no meter exists. Free IPv6 also receives renewable deadlines.

rateMicrosinteger

Immutable quoted monthly price in millionths of a US dollar.

rateUnit'unit_month'
idstring
subnetstring
gatewayAddressstring
endpointstring

Where peers send WireGuard: address:udpPort.

gatewayPublicKeystring nullable

Null until a funded gateway is ready.

disabledboolean
createdAtstring date-time

Changes

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