From 62eeaf79e2fdc52016b2d6b8e9b8a6da16337dcb Mon Sep 17 00:00:00 2001 From: cynfo3000 Date: Sat, 28 Feb 2026 11:28:22 +0100 Subject: [PATCH] README: Alle Beispiele mit echten Zugangsdaten, alle 3 Agent-IDs dokumentiert --- README.md | 74 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 48 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 10a6de9..5f91812 100644 --- a/README.md +++ b/README.md @@ -231,9 +231,13 @@ curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X DELETE \ ### Zugangsdaten ``` -Backend: https://192.168.85.13:8443 -API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9 -Agent-ID: e92e87a684b20db15d8d2344583c5887 (OPN-REP.intra.weidenhaupt.net) +Backend: https://192.168.85.13:8443 +API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9 + +Agent-IDs: + 6beb8dfd38ecf03eab6c0f21b4ac7bee OPN-PROD.intra.weidenhaupt.net (192.168.85.1, READ-ONLY) + e92e87a684b20db15d8d2344583c5887 OPN-REP.intra.weidenhaupt.net (192.168.85.33) + 1697d28e57bc126534afc282b5de8ee0 OPN-TEST-UPDATE (192.168.85.19) ``` ### Agent-Beispiele @@ -290,45 +294,63 @@ curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ 4. `configctl wireguard configure` laedt die Aenderung 5. Response enthaelt die komplette Client-Config (ready for import) -**Beispiel:** +**Beispiele:** ```bash -# Peer anlegen -curl -sk -H "X-API-Key: API_KEY" -X POST \ - https://BACKEND/api/v1/agents/AGENT_ID/wireguard/peers \ +# Peer anlegen (erster Peer bekommt .2, zweiter .3, etc.) +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers \ -d '{"name":"VPN_MUELLER","allowed_ips":"0.0.0.0/0","dns":"10.172.100.210"}' -# Response enthaelt client_config: -# [Interface] -# PrivateKey = ... -# Address = 10.33.144.2/32 -# DNS = 10.172.100.210 -# -# [Peer] -# PublicKey = ... -# AllowedIPs = 0.0.0.0/0 -# Endpoint = 79.238.149.26:8080 -# PersistentKeepalive = 25 +# Response: +# { +# "status": "ok", +# "data": { +# "peer_uuid": "abc123...", +# "name": "VPN_MUELLER", +# "client_ip": "10.33.144.2", +# "endpoint": "79.238.149.26:8080", +# "client_config": "[Interface]\nPrivateKey = ...\nAddress = 10.33.144.2/32\n..." +# } +# } -# Peers auflisten -curl -sk -H "X-API-Key: API_KEY" \ - https://BACKEND/api/v1/agents/AGENT_ID/wireguard/peers +# Zweiten Peer anlegen (bekommt automatisch .3) +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers \ + -d '{"name":"VPN_SCHMIDT","allowed_ips":"0.0.0.0/0","dns":"10.172.100.210"}' -# Peer loeschen -curl -sk -H "X-API-Key: API_KEY" -X DELETE \ - https://BACKEND/api/v1/agents/AGENT_ID/wireguard/peers/PEER_UUID +# Peer mit eigenem Endpoint (z.B. DynDNS) +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers \ + -d '{"name":"VPN_EXTERN","allowed_ips":"0.0.0.0/0","endpoint":"vpn.kunde.de:8080"}' + +# Alle Peers auflisten +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers + +# Peers einer bestimmten Instanz auflisten +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" \ + "https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers?server_name=ALWAYSON_VPN" + +# Peer loeschen (UUID aus der List-Response) +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X DELETE \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/wireguard/peers/89c10e2d-148e-11f1-a7af-7c5a1c6c7b73 ``` ### Backup-Beispiele ```bash -# Backup ausloesen +# Backup ausloesen (Produktion .1) +curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/backup + +# Backup ausloesen (Test .33) curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" -X POST \ https://192.168.85.13:8443/api/v1/agents/e92e87a684b20db15d8d2344583c5887/backup # Alle Backups auflisten curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" \ - https://192.168.85.13:8443/api/v1/agents/e92e87a684b20db15d8d2344583c5887/backups + https://192.168.85.13:8443/api/v1/agents/6beb8dfd38ecf03eab6c0f21b4ac7bee/backups # Neuestes Backup als XML herunterladen curl -sk -H "X-API-Key: 01532e5a7c9e70bf2757df77a2f5b9b9" \