{- "data": [
- {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_interface",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "name": "test interface",
- "status": "provisioned",
- "endpoint": "203.0.113.0:51871",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "region_code": "ashburn-va",
- "region": {
- "code": "ashburn-va",
- "name": "Ashburn",
- "record_type": "region"
}
}
], - "meta": {
- "total_pages": 3,
- "total_results": 55,
- "page_number": 2,
- "page_size": 25
}
}
Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.
Successful response
Unprocessable entity. Check the 'detail' field in response for details.
{- "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "name": "test interface",
- "region_code": "ashburn-va"
}
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_interface",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "name": "test interface",
- "status": "provisioned",
- "endpoint": "203.0.113.0:51871",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "region_code": "ashburn-va",
- "region": {
- "code": "ashburn-va",
- "name": "Ashburn",
- "record_type": "region"
}
}
}
Retrieve a WireGuard Interfaces.
Successful response
object (WireguardInterfaceRead) | |||||||||||||||||||||||
|
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_interface",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "name": "test interface",
- "status": "provisioned",
- "endpoint": "203.0.113.0:51871",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "region_code": "ashburn-va",
- "region": {
- "code": "ashburn-va",
- "name": "Ashburn",
- "record_type": "region"
}
}
}
Delete a WireGuard Interface.
Successful response
object (WireguardInterfaceRead) | |||||||||||||||||||||||
|
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_interface",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "name": "test interface",
- "status": "provisioned",
- "endpoint": "203.0.113.0:51871",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "region_code": "ashburn-va",
- "region": {
- "code": "ashburn-va",
- "name": "Ashburn",
- "record_type": "region"
}
}
}
List all WireGuard peers.
page[number] | integer >= 1 Default: 1 The page number to load |
page[size] | integer [ 1 .. 250 ] Default: 20 The size of the page |
filter[wireguard_interface_id] | string <uuid> The id of the associated WireGuard interface to filter on. Example: filter[wireguard_interface_id]=6a09cdc3-8948-47f0-aa62-74ac943d6c58 |
{- "data": [
- {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_peer",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "last_seen": "2018-02-02T22:25:27.521Z",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
], - "meta": {
- "total_pages": 3,
- "total_results": 55,
- "page_number": 2,
- "page_size": 25
}
}
Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.
Successful response
object (WireguardPeer) | |||||||||||||||||
|
Unprocessable entity. Check the 'detail' field in response for details.
{- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_peer",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "last_seen": "2018-02-02T22:25:27.521Z",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
}
Retrieve the WireGuard peer.
Successful response
object (WireguardPeer) | |||||||||||||||||
|
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_peer",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "last_seen": "2018-02-02T22:25:27.521Z",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
}
Update the WireGuard peer.
Successful response
object (WireguardPeer) | |||||||||||||||||
|
Unprocessable entity. Check the 'detail' field in response for details.
{- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_peer",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "last_seen": "2018-02-02T22:25:27.521Z",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
}
Delete the WireGuard peer.
Successful response
object (WireguardPeer) | |||||||||||||||||
|
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_peer",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
- "last_seen": "2018-02-02T22:25:27.521Z",
- "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}
}
Retrieve Wireguard config template for Peer
{- "errors": [
- {
- "code": "string",
- "title": "string",
- "detail": "string",
- "source": {
- "pointer": "/json/pointer",
- "parameter": "string"
}, - "meta": { }
}
]
}
List all Allowed IPs for a WireGuard peer.
{- "data": [
- {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_allowed_ip",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "ip_address": "198.51.100.1"
}
], - "meta": {
- "total_pages": 3,
- "total_results": 55,
- "page_number": 2,
- "page_size": 25
}
}
Retrieve the Allowed IP.
Successful response
object (WireguardPeerAllowedIP) | |||||||||||
|
{- "data": {
- "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
- "record_type": "wireguard_allowed_ip",
- "created_at": "2018-02-02T22:25:27.521Z",
- "updated_at": "2018-02-02T22:25:27.521Z",
- "ip_address": "198.51.100.1"
}
}