From 7f28edbefde29a9cc08ad1552173fe956248da87 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Sat, 18 Jan 2025 11:13:44 +0000
Subject: [PATCH] Deployed 31c0dae to master with MkDocs 1.6.1 and mike 2.1.3

---
 .../documentation/rest-api/api-doc/index.html |    2 +-
 ...er-c860b3e8.html => swagger-483b3727.html} |    4 +-
 master/documentation/rest-api/swagger.yaml    | 1546 +++++++++++++++++
 3 files changed, 1549 insertions(+), 3 deletions(-)
 rename master/documentation/rest-api/api-doc/{swagger-c860b3e8.html => swagger-483b3727.html} (97%)
 create mode 100644 master/documentation/rest-api/swagger.yaml
diff --git a/master/documentation/rest-api/api-doc/index.html b/master/documentation/rest-api/api-doc/index.html
index 5c17cef..7b08aa5 100644
--- a/master/documentation/rest-api/api-doc/index.html
+++ b/master/documentation/rest-api/api-doc/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html class="no-js" lang="en"> <head><meta charset="utf-8"/><meta content="width=device-width,initial-scale=1" name="viewport"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="description"/><link href="https://wgportal.org/master/documentation/rest-api/api-doc/" rel="canonical"/><link href="../../configuration/examples/" rel="prev"/><link href="../../../assets/images/favicon-large.png" rel="icon"/><meta content="mkdocs-1.6.1, mkdocs-material-9.5.50" name="generator"/><title>REST API - WireGuard Portal</title><link href="../../../assets/stylesheets/main.a40c8224.min.css" rel="stylesheet"/><link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/><link href="../../../stylesheets/extra.css" rel="stylesheet"/><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta content="website" property="og:type"/><meta content="REST API - WireGuard Portal" property="og:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." property="og:description"/><meta content="https://wgportal.org/master/assets/images/social/documentation/rest-api/api-doc.png" property="og:image"/><meta content="image/png" property="og:image:type"/><meta content="1200" property="og:image:width"/><meta content="630" property="og:image:height"/><meta content="https://wgportal.org/master/documentation/rest-api/api-doc/" property="og:url"/><meta content="summary_large_image" name="twitter:card"/><meta content="REST API - WireGuard Portal" name="twitter:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="twitter:description"/><meta content="https://wgportal.org/master/assets/images/social/documentation/rest-api/api-doc.png" name="twitter:image"/></head> <body data-md-color-accent="indigo" data-md-color-primary="white" data-md-color-scheme="default" dir="ltr"> <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/> <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> </div> <div data-md-component="announce"> </div> <div data-md-color-scheme="default" data-md-component="outdated" hidden=""> </div> <header class="md-header" data-md-component="header"> <nav aria-label="Header" class="md-header__inner md-grid"> <a aria-label="WireGuard Portal" class="md-header__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> <label class="md-header__button md-icon" for="__drawer"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> WireGuard Portal </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> REST API </span> </div> </div> </div> <label class="md-header__button md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/> <label class="md-search__icon md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg> </label> <nav aria-label="Search" class="md-search__options"> <button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0"> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav aria-label="Tabs" class="md-tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a class="md-tabs__link" href="../../.."> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a class="md-tabs__link" href="../../overview/"> Documentation </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Navigation" class="md-nav md-nav--primary md-nav--lifted" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a aria-label="WireGuard Portal" class="md-nav__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> WireGuard Portal </label> <div class="md-nav__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../.."> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input checked="" class="md-nav__toggle md-toggle" id="__nav_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex=""> <span class="md-ellipsis"> Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="true" aria-labelledby="__nav_2_label" class="md-nav" data-md-level="1"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Documentation </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" id="__nav_2_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0"> <span class="md-ellipsis"> Getting Started </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" aria-labelledby="__nav_2_2_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_2"> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/building/"> <span class="md-ellipsis"> Building </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/docker/"> <span class="md-ellipsis"> Docker Container </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/upgrade/"> <span class="md-ellipsis"> Upgrade from V1 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" id="__nav_2_3" type="checkbox"/> <label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0"> <span class="md-ellipsis"> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" aria-labelledby="__nav_2_3_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_3"> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../configuration/overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../configuration/examples/"> <span class="md-ellipsis"> Examples </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/> <a class="md-nav__link md-nav__link--active" href="./"> <span class="md-ellipsis"> REST API </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Table of contents" class="md-nav md-nav--secondary"> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1>REST API</h1> <p><iframe class="swagger-ui-iframe" frameborder="0" id="c860b3e8" src="swagger-c860b3e8.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <!-- Application footer --> <footer class="md-footer"> <!-- Further information --> <div class="md-footer-meta md-typeset" style="background-color: #fff;"> <div class="md-footer-meta__inner md-grid" style="background-color: #fff;"> <!-- Copyright and theme information --> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight" style="color: rgb(38, 38, 38);"> Copyright © 2023-2025 WireGuard Portal Project </div> <div style="color: rgb(38, 38, 38);"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" style="color: black;" target="_blank"> Material for MkDocs </a> </div> </div> <!-- Social links --> <div class="md-social"> <a class="md-social__link" href="https://github.com/h44z/wg-portal" rel="noopener" target="_blank" title="github.com"> <svg viewbox="0 0 480 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1M480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2m-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3m-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1"></path></svg> </a> <a class="md-social__link" href="https://hub.docker.com/r/wgportal/wg-portal" rel="noopener" target="_blank" title="hub.docker.com"> <svg viewbox="0 0 640 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"></path></svg> </a> <a class="md-social__link" href="https://twitter.com/chris_h44z" rel="noopener" target="_blank" title="twitter.com"> <svg viewbox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"></path></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.tabs", "navigation.expand"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src="../../../assets/javascripts/bundle.60a45f97.min.js"></script> <script>document$.subscribe(() => {
+<html class="no-js" lang="en"> <head><meta charset="utf-8"/><meta content="width=device-width,initial-scale=1" name="viewport"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="description"/><link href="https://wgportal.org/master/documentation/rest-api/api-doc/" rel="canonical"/><link href="../../configuration/examples/" rel="prev"/><link href="../../../assets/images/favicon-large.png" rel="icon"/><meta content="mkdocs-1.6.1, mkdocs-material-9.5.50" name="generator"/><title>REST API - WireGuard Portal</title><link href="../../../assets/stylesheets/main.a40c8224.min.css" rel="stylesheet"/><link href="../../../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/><link href="../../../stylesheets/extra.css" rel="stylesheet"/><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta content="website" property="og:type"/><meta content="REST API - WireGuard Portal" property="og:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." property="og:description"/><meta content="https://wgportal.org/master/assets/images/social/documentation/rest-api/api-doc.png" property="og:image"/><meta content="image/png" property="og:image:type"/><meta content="1200" property="og:image:width"/><meta content="630" property="og:image:height"/><meta content="https://wgportal.org/master/documentation/rest-api/api-doc/" property="og:url"/><meta content="summary_large_image" name="twitter:card"/><meta content="REST API - WireGuard Portal" name="twitter:title"/><meta content="Manage WireGuard Peers and Interface using a beautiful and simple web UI." name="twitter:description"/><meta content="https://wgportal.org/master/assets/images/social/documentation/rest-api/api-doc.png" name="twitter:image"/></head> <body data-md-color-accent="indigo" data-md-color-primary="white" data-md-color-scheme="default" dir="ltr"> <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/> <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> </div> <div data-md-component="announce"> </div> <div data-md-color-scheme="default" data-md-component="outdated" hidden=""> </div> <header class="md-header" data-md-component="header"> <nav aria-label="Header" class="md-header__inner md-grid"> <a aria-label="WireGuard Portal" class="md-header__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> <label class="md-header__button md-icon" for="__drawer"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"></path></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> WireGuard Portal </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> REST API </span> </div> </div> </div> <label class="md-header__button md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/> <label class="md-search__icon md-icon" for="__search"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path></svg> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path></svg> </label> <nav aria-label="Search" class="md-search__options"> <button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset"> <svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" data-md-scrollfix="" tabindex="0"> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <nav aria-label="Tabs" class="md-tabs" data-md-component="tabs"> <div class="md-grid"> <ul class="md-tabs__list"> <li class="md-tabs__item"> <a class="md-tabs__link" href="../../.."> Home </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a class="md-tabs__link" href="../../overview/"> Documentation </a> </li> </ul> </div> </nav> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Navigation" class="md-nav md-nav--primary md-nav--lifted" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a aria-label="WireGuard Portal" class="md-nav__button md-logo" data-md-component="logo" href="../../.." title="WireGuard Portal"> <img alt="logo" src="../../../assets/images/logo.svg"/> </a> WireGuard Portal </label> <div class="md-nav__source"> <a class="md-source" data-md-component="source" href="https://github.com/h44z/wg-portal" title="Go to repository"> <div class="md-source__icon md-icon"> <svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"></path></svg> </div> <div class="md-source__repository"> h44z/wg-portal </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../.."> <span class="md-ellipsis"> Home </span> </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input checked="" class="md-nav__toggle md-toggle" id="__nav_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex=""> <span class="md-ellipsis"> Documentation </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="true" aria-labelledby="__nav_2_label" class="md-nav" data-md-level="1"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Documentation </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" id="__nav_2_2" type="checkbox"/> <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0"> <span class="md-ellipsis"> Getting Started </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" aria-labelledby="__nav_2_2_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_2"> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/building/"> <span class="md-ellipsis"> Building </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/docker/"> <span class="md-ellipsis"> Docker Container </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../getting-started/upgrade/"> <span class="md-ellipsis"> Upgrade from V1 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" id="__nav_2_3" type="checkbox"/> <label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0"> <span class="md-ellipsis"> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav aria-expanded="false" aria-labelledby="__nav_2_3_label" class="md-nav" data-md-level="2"> <label class="md-nav__title" for="__nav_2_3"> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class="md-nav__list" data-md-scrollfix=""> <li class="md-nav__item"> <a class="md-nav__link" href="../../configuration/overview/"> <span class="md-ellipsis"> Overview </span> </a> </li> <li class="md-nav__item"> <a class="md-nav__link" href="../../configuration/examples/"> <span class="md-ellipsis"> Examples </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" id="__toc" type="checkbox"/> <a class="md-nav__link md-nav__link--active" href="./"> <span class="md-ellipsis"> REST API </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc"> <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav aria-label="Table of contents" class="md-nav md-nav--secondary"> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1>REST API</h1> <p><iframe class="swagger-ui-iframe" frameborder="0" id="483b3727" src="swagger-483b3727.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <!-- Application footer --> <footer class="md-footer"> <!-- Further information --> <div class="md-footer-meta md-typeset" style="background-color: #fff;"> <div class="md-footer-meta__inner md-grid" style="background-color: #fff;"> <!-- Copyright and theme information --> <div class="md-footer-copyright"> <div class="md-footer-copyright__highlight" style="color: rgb(38, 38, 38);"> Copyright © 2023-2025 WireGuard Portal Project </div> <div style="color: rgb(38, 38, 38);"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" style="color: black;" target="_blank"> Material for MkDocs </a> </div> </div> <!-- Social links --> <div class="md-social"> <a class="md-social__link" href="https://github.com/h44z/wg-portal" rel="noopener" target="_blank" title="github.com"> <svg viewbox="0 0 480 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1M480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2m-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3m-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1"></path></svg> </a> <a class="md-social__link" href="https://hub.docker.com/r/wgportal/wg-portal" rel="noopener" target="_blank" title="hub.docker.com"> <svg viewbox="0 0 640 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"></path></svg> </a> <a class="md-social__link" href="https://twitter.com/chris_h44z" rel="noopener" target="_blank" title="twitter.com"> <svg viewbox="0 0 512 512" xmlns="http://www.w3.org/2000/svg"><!-- Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"></path></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.tabs", "navigation.expand"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "latest", "provider": "mike"}}</script> <script src="../../../assets/javascripts/bundle.60a45f97.min.js"></script> <script>document$.subscribe(() => {
             window.update_swagger_ui_iframe_height = function (id) {
                 var iFrameID = document.getElementById(id);
                 if (iFrameID) {
diff --git a/master/documentation/rest-api/api-doc/swagger-c860b3e8.html b/master/documentation/rest-api/api-doc/swagger-483b3727.html
similarity index 97%
rename from master/documentation/rest-api/api-doc/swagger-c860b3e8.html
rename to master/documentation/rest-api/api-doc/swagger-483b3727.html
index fdaf683..6b2a5cb 100644
--- a/master/documentation/rest-api/api-doc/swagger-c860b3e8.html
+++ b/master/documentation/rest-api/api-doc/swagger-483b3727.html
@@ -23,7 +23,7 @@
           SwaggerUIStandalonePreset
         ],
         
-        url: "./swagger.yaml",
+        url: "../swagger.yaml",
         
         
         "oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
@@ -67,7 +67,7 @@
     }
 
     const resize_ob = new ResizeObserver(function(entries) {
-      parent.update_swagger_ui_iframe_height("c860b3e8");
+      parent.update_swagger_ui_iframe_height("483b3727");
     });
 
     // start observing for resizing
diff --git a/master/documentation/rest-api/swagger.yaml b/master/documentation/rest-api/swagger.yaml
new file mode 100644
index 0000000..2f092b7
--- /dev/null
+++ b/master/documentation/rest-api/swagger.yaml
@@ -0,0 +1,1546 @@
+basePath: /api/v1
+definitions:
+  models.ConfigOption-array_string:
+    properties:
+      Overridable:
+        type: boolean
+      Value:
+        items:
+          type: string
+        type: array
+    type: object
+  models.ConfigOption-int:
+    properties:
+      Overridable:
+        type: boolean
+      Value:
+        type: integer
+    type: object
+  models.ConfigOption-string:
+    properties:
+      Overridable:
+        type: boolean
+      Value:
+        type: string
+    type: object
+  models.ConfigOption-uint32:
+    properties:
+      Overridable:
+        type: boolean
+      Value:
+        type: integer
+    type: object
+  models.Error:
+    properties:
+      Code:
+        description: HTTP status code.
+        type: integer
+      Details:
+        description: Additional error details.
+        type: string
+      Message:
+        description: Error message.
+        type: string
+    type: object
+  models.ExpiryDate:
+    properties:
+      time.Time:
+        type: string
+    type: object
+  models.Interface:
+    properties:
+      Addresses:
+        description: Addresses is a list of IP addresses (in CIDR format) that are
+          assigned to the interface.
+        example:
+        - 10.11.12.1/24
+        items:
+          type: string
+        type: array
+      Disabled:
+        description: Disabled is a flag that specifies if the interface is enabled
+          (up) or not (down). Disabled interfaces are not able to accept connections.
+        example: false
+        type: boolean
+      DisabledReason:
+        description: DisabledReason is the reason why the interface has been disabled.
+        example: This is a reason why the interface has been disabled.
+        type: string
+      DisplayName:
+        description: DisplayName is a nice display name / description for the interface.
+        example: My Interface
+        maxLength: 64
+        type: string
+      Dns:
+        description: Dns is a list of DNS servers that should be set if the interface
+          is up.
+        example:
+        - 1.1.1.1
+        items:
+          type: string
+        type: array
+      DnsSearch:
+        description: DnsSearch is the dns search option string that should be set
+          if the interface is up, will be appended to Dns servers.
+        example:
+        - wg.local
+        items:
+          type: string
+        type: array
+      EnabledPeers:
+        description: EnabledPeers is the number of enabled peers for this interface.
+          Only enabled peers are able to connect.
+        readOnly: true
+        type: integer
+      FirewallMark:
+        description: FirewallMark is an optional firewall mark which is used to handle
+          interface traffic.
+        type: integer
+      Identifier:
+        description: Identifier is the unique identifier of the interface. It is always
+          equal to the device name of the interface.
+        example: wg0
+        type: string
+      ListenPort:
+        description: 'ListenPort is the listening port, for example: 51820. The listening
+          port is only required for server interfaces.'
+        example: 51820
+        maximum: 65535
+        minimum: 1
+        type: integer
+      Mode:
+        description: Mode is the interface type, either 'server', 'client' or 'any'.
+          The mode specifies how WireGuard Portal handles peers for this interface.
+        enum:
+        - server
+        - client
+        - any
+        example: server
+        type: string
+      Mtu:
+        description: Mtu is the device MTU of the interface.
+        example: 1420
+        maximum: 9000
+        minimum: 1
+        type: integer
+      PeerDefAllowedIPs:
+        description: PeerDefAllowedIPs specifies the default allowed IP addresses
+          for a new peer.
+        example:
+        - 10.11.12.0/24
+        items:
+          type: string
+        type: array
+      PeerDefDns:
+        description: PeerDefDns specifies the default dns servers for a new peer.
+        example:
+        - 8.8.8.8
+        items:
+          type: string
+        type: array
+      PeerDefDnsSearch:
+        description: PeerDefDnsSearch specifies the default dns search options for
+          a new peer.
+        example:
+        - wg.local
+        items:
+          type: string
+        type: array
+      PeerDefEndpoint:
+        description: PeerDefEndpoint specifies the default endpoint for a new peer.
+        example: wg.example.com:51820
+        type: string
+      PeerDefFirewallMark:
+        description: PeerDefFirewallMark specifies the default firewall mark for a
+          new peer.
+        type: integer
+      PeerDefMtu:
+        description: PeerDefMtu specifies the default device MTU for a new peer.
+        example: 1420
+        type: integer
+      PeerDefNetwork:
+        description: PeerDefNetwork specifies the default subnets from which new peers
+          will get their IP addresses. The subnet is specified in CIDR format.
+        example:
+        - 10.11.12.0/24
+        items:
+          type: string
+        type: array
+      PeerDefPersistentKeepalive:
+        description: PeerDefPersistentKeepalive specifies the default persistent keep-alive
+          value in seconds for a new peer.
+        example: 25
+        type: integer
+      PeerDefPostDown:
+        description: PeerDefPostDown specifies the default action that is executed
+          after the device is down for a new peer.
+        type: string
+      PeerDefPostUp:
+        description: PeerDefPostUp specifies the default action that is executed after
+          the device is up for a new peer.
+        type: string
+      PeerDefPreDown:
+        description: PeerDefPreDown specifies the default action that is executed
+          before the device is down for a new peer.
+        type: string
+      PeerDefPreUp:
+        description: PeerDefPreUp specifies the default action that is executed before
+          the device is up for a new peer.
+        type: string
+      PeerDefRoutingTable:
+        description: PeerDefRoutingTable specifies the default routing table for a
+          new peer.
+        type: string
+      PostDown:
+        description: PostDown is an optional action that is executed after the device
+          is down.
+        example: echo 'Interface is down'
+        type: string
+      PostUp:
+        description: PostUp is an optional action that is executed after the device
+          is up.
+        example: iptables -A FORWARD -i %i -j ACCEPT
+        type: string
+      PreDown:
+        description: PreDown is an optional action that is executed before the device
+          is down.
+        example: iptables -D FORWARD -i %i -j ACCEPT
+        type: string
+      PreUp:
+        description: PreUp is an optional action that is executed before the device
+          is up.
+        example: echo 'Interface is up'
+        type: string
+      PrivateKey:
+        description: PrivateKey is the private key of the interface.
+        example: gI6EdUSYvn8ugXOt8QQD6Yc+JyiZxIhp3GInSWRfWGE=
+        type: string
+      PublicKey:
+        description: PublicKey is the public key of the server interface. The public
+          key is used by peers to connect to the server.
+        example: HIgo9xNzJMWLKASShiTqIybxZ0U3wGLiUeJ1PKf8ykw=
+        type: string
+      RoutingTable:
+        description: RoutingTable is an optional routing table which is used to route
+          interface traffic.
+        type: string
+      SaveConfig:
+        description: SaveConfig is a flag that specifies if the configuration should
+          be saved to the configuration file (wgX.conf in wg-quick format).
+        example: false
+        type: boolean
+      TotalPeers:
+        description: TotalPeers is the total number of peers for this interface.
+        readOnly: true
+        type: integer
+    required:
+    - Identifier
+    - Mode
+    - PrivateKey
+    - PublicKey
+    type: object
+  models.InterfaceMetrics:
+    properties:
+      BytesReceived:
+        description: The number of bytes received by the interface.
+        example: 123456789
+        type: integer
+      BytesTransmitted:
+        description: The number of bytes transmitted by the interface.
+        example: 123456789
+        type: integer
+      InterfaceIdentifier:
+        description: The unique identifier of the interface.
+        example: wg0
+        type: string
+    type: object
+  models.Peer:
+    properties:
+      Addresses:
+        description: Addresses is a list of IP addresses in CIDR format (both IPv4
+          and IPv6) for the peer.
+        example:
+        - 10.11.12.2/24
+        items:
+          type: string
+        type: array
+      AllowedIPs:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-array_string'
+        description: AllowedIPs is a list of allowed IP subnets for the peer.
+      CheckAliveAddress:
+        description: CheckAliveAddress is an optional ip address or DNS name that
+          is used for ping checks.
+        example: 1.1.1.1
+        type: string
+      Disabled:
+        description: Disabled is a flag that specifies if the peer is enabled or not.
+          Disabled peers are not able to connect.
+        example: false
+        type: boolean
+      DisabledReason:
+        description: DisabledReason is the reason why the peer has been disabled.
+        example: This is a reason why the peer has been disabled.
+        type: string
+      DisplayName:
+        description: DisplayName is a nice display name / description for the peer.
+        example: My Peer
+        maxLength: 64
+        type: string
+      Dns:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-array_string'
+        description: Dns is a list of DNS servers that should be set if the peer interface
+          is up.
+      DnsSearch:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-array_string'
+        description: DnsSearch is the dns search option string that should be set
+          if the peer interface is up, will be appended to Dns servers.
+      Endpoint:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: Endpoint is the endpoint address of the peer.
+      EndpointPublicKey:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: EndpointPublicKey is the endpoint public key.
+      ExpiresAt:
+        allOf:
+        - $ref: '#/definitions/models.ExpiryDate'
+        description: ExpiresAt is the expiry date of the peer  in YYYY-MM-DD format.
+          An expired peer is not able to connect.
+      ExtraAllowedIPs:
+        description: ExtraAllowedIPs is a list of additional allowed IP subnets for
+          the peer. These allowed IP subnets are added on the server side.
+        items:
+          type: string
+        type: array
+      FirewallMark:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-uint32'
+        description: FirewallMark is an optional firewall mark which is used to handle
+          peer traffic.
+      Identifier:
+        description: Identifier is the unique identifier of the peer. It is always
+          equal to the public key of the peer.
+        example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
+        type: string
+      InterfaceIdentifier:
+        description: InterfaceIdentifier is the identifier of the interface the peer
+          is linked to.
+        example: wg0
+        type: string
+      Mode:
+        description: Mode is the peer interface type (server, client, any).
+        enum:
+        - server
+        - client
+        - any
+        example: client
+        type: string
+      Mtu:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-int'
+        description: Mtu is the device MTU of the peer.
+      Notes:
+        description: Notes is a note field for peers.
+        example: This is a note for the peer.
+        type: string
+      PersistentKeepalive:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-int'
+        description: PersistentKeepalive is the optional persistent keep-alive interval
+          in seconds.
+      PostDown:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: PostDown is an optional action that is executed after the device
+          is down.
+      PostUp:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: PostUp is an optional action that is executed after the device
+          is up.
+      PreDown:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: PreDown is an optional action that is executed before the device
+          is down.
+      PreUp:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: PreUp is an optional action that is executed before the device
+          is up.
+      PresharedKey:
+        description: PresharedKey is the optional pre-shared Key of the peer.
+        example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
+        type: string
+      PrivateKey:
+        description: PrivateKey is the private Key of the peer.
+        example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
+        type: string
+      PublicKey:
+        description: PublicKey is the public Key of the server peer.
+        example: TrMvSoP4jYQlY6RIzBgbssQqY3vxI2Pi+y71lOWWXX0=
+        type: string
+      RoutingTable:
+        allOf:
+        - $ref: '#/definitions/models.ConfigOption-string'
+        description: RoutingTable is an optional routing table which is used to route
+          peer traffic.
+      UserIdentifier:
+        description: UserIdentifier is the identifier of the user that owns the peer.
+        example: uid-1234567
+        type: string
+    required:
+    - Identifier
+    - InterfaceIdentifier
+    - PrivateKey
+    type: object
+  models.PeerMetrics:
+    properties:
+      BytesReceived:
+        description: The number of bytes received by the peer.
+        example: 123456789
+        type: integer
+      BytesTransmitted:
+        description: The number of bytes transmitted by the peer.
+        example: 123456789
+        type: integer
+      Endpoint:
+        description: The current endpoint address of the peer.
+        example: 12.34.56.78
+        type: string
+      IsPingable:
+        description: If this field is set, the peer is pingable.
+        example: true
+        type: boolean
+      LastHandshake:
+        description: The last time the peer initiated a handshake.
+        example: "2021-01-01T12:00:00Z"
+        type: string
+      LastPing:
+        description: The last time the peer responded to a ICMP ping request.
+        example: "2021-01-01T12:00:00Z"
+        type: string
+      LastSessionStart:
+        description: The last time the peer initiated a session.
+        example: "2021-01-01T12:00:00Z"
+        type: string
+      PeerIdentifier:
+        description: The unique identifier of the peer.
+        example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
+        type: string
+    type: object
+  models.ProvisioningRequest:
+    properties:
+      InterfaceIdentifier:
+        description: InterfaceIdentifier is the identifier of the WireGuard interface
+          the peer should be linked to.
+        example: wg0
+        type: string
+      PresharedKey:
+        description: PresharedKey is the optional pre-shared key of the peer. If no
+          pre-shared key is set, a new key is generated.
+        example: yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
+        type: string
+      PublicKey:
+        description: PublicKey is the optional public key of the peer. If no public
+          key is set, a new key pair is generated.
+        example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
+        type: string
+      UserIdentifier:
+        description: |-
+          UserIdentifier is the identifier of the user the peer should be linked to.
+          If no user identifier is set, the authenticated user is used.
+        example: uid-1234567
+        type: string
+    required:
+    - InterfaceIdentifier
+    type: object
+  models.User:
+    properties:
+      ApiEnabled:
+        description: If this field is set, the user is allowed to use the RESTful
+          API. This field is read-only.
+        example: false
+        readOnly: true
+        type: boolean
+      ApiToken:
+        description: The API token of the user. This field is never populated on bulk
+          read operations.
+        example: ""
+        maxLength: 64
+        minLength: 32
+        type: string
+      Department:
+        description: The department of the user. This field is optional.
+        example: Software Development
+        type: string
+      Disabled:
+        description: If this field is set, the user is disabled.
+        example: false
+        type: boolean
+      DisabledReason:
+        description: The reason why the user has been disabled.
+        example: ""
+        type: string
+      Email:
+        description: The email address of the user. This field is optional.
+        example: test@test.com
+        type: string
+      Firstname:
+        description: The first name of the user. This field is optional.
+        example: Max
+        type: string
+      Identifier:
+        description: The unique identifier of the user.
+        example: uid-1234567
+        maxLength: 64
+        type: string
+      IsAdmin:
+        description: If this field is set, the user is an admin.
+        example: false
+        type: boolean
+      Lastname:
+        description: The last name of the user. This field is optional.
+        example: Muster
+        type: string
+      Locked:
+        description: If this field is set, the user is locked and thus unable to log
+          in to WireGuard Portal.
+        example: false
+        type: boolean
+      LockedReason:
+        description: The reason why the user has been locked.
+        example: ""
+        type: string
+      Notes:
+        description: Additional notes about the user. This field is optional.
+        example: some sample notes
+        type: string
+      Password:
+        description: The password of the user. This field is never populated on read
+          operations.
+        example: ""
+        maxLength: 64
+        minLength: 16
+        type: string
+      PeerCount:
+        description: The number of peers linked to the user. This field is read-only.
+        example: 2
+        readOnly: true
+        type: integer
+      Phone:
+        description: The phone number of the user. This field is optional.
+        example: "+1234546789"
+        type: string
+      ProviderName:
+        description: The name of the authentication provider. This field is read-only.
+        example: ""
+        readOnly: true
+        type: string
+      Source:
+        description: The source of the user. This field is optional.
+        enum:
+        - db
+        example: db
+        type: string
+    required:
+    - Identifier
+    - IsAdmin
+    type: object
+  models.UserInformation:
+    properties:
+      PeerCount:
+        description: PeerCount is the number of peers linked to the user.
+        example: 2
+        type: integer
+      Peers:
+        description: Peers is a list of peers linked to the user.
+        items:
+          $ref: '#/definitions/models.UserInformationPeer'
+        type: array
+      UserIdentifier:
+        description: UserIdentifier is the unique identifier of the user.
+        example: uid-1234567
+        type: string
+    type: object
+  models.UserInformationPeer:
+    properties:
+      DisplayName:
+        description: DisplayName is a user-defined description of the peer.
+        example: My iPhone
+        type: string
+      Identifier:
+        description: Identifier is the unique identifier of the peer. It equals the
+          public key of the peer.
+        example: peer-1234567
+        type: string
+      InterfaceIdentifier:
+        description: InterfaceIdentifier is the unique identifier of the WireGuard
+          Portal device the peer is connected to.
+        example: wg0
+        type: string
+      IpAddresses:
+        description: IPAddresses is a list of IP addresses in CIDR format assigned
+          to the peer.
+        example:
+        - 10.11.12.2/24
+        items:
+          type: string
+        type: array
+      IsDisabled:
+        description: IsDisabled is a flag that specifies if the peer is enabled or
+          not. Disabled peers are not able to connect.
+        example: true
+        type: boolean
+    type: object
+  models.UserMetrics:
+    properties:
+      BytesReceived:
+        description: The total number of bytes received by the user. This is the sum
+          of all bytes received by the peers linked to the user.
+        example: 123456789
+        type: integer
+      BytesTransmitted:
+        description: The total number of bytes transmitted by the user. This is the
+          sum of all bytes transmitted by the peers linked to the user.
+        example: 123456789
+        type: integer
+      PeerCount:
+        description: PeerCount represents the number of peers linked to the user.
+        example: 2
+        type: integer
+      PeerMetrics:
+        description: PeerMetrics represents the metrics of the peers linked to the
+          user.
+        items:
+          $ref: '#/definitions/models.PeerMetrics'
+        type: array
+      UserIdentifier:
+        description: The unique identifier of the user.
+        example: uid-1234567
+        type: string
+    type: object
+info:
+  contact:
+    name: WireGuard Portal Project
+    url: https://github.com/h44z/wg-portal
+  description: |-
+    The WireGuard Portal REST API enables efficient management of WireGuard VPN configurations through a set of JSON-based endpoints.
+    It supports creating and editing peers, interfaces, and user profiles, while also providing role-based access control and auditing.
+    This API allows seamless integration with external tools or scripts for automated network configuration and administration.
+  license:
+    name: MIT
+    url: https://github.com/h44z/wg-portal/blob/master/LICENSE.txt
+  title: WireGuard Portal Public API
+  version: "1.0"
+paths:
+  /interface/all:
+    get:
+      operationId: interface_handleAllGet
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/models.Interface'
+            type: array
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all interface records.
+      tags:
+      - Interfaces
+  /interface/by-id/{id}:
+    delete:
+      operationId: interfaces_handleDelete
+      parameters:
+      - description: The interface identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "204":
+          description: No content if deletion was successful.
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Delete the interface record.
+      tags:
+      - Interfaces
+    get:
+      operationId: interfaces_handleByIdGet
+      parameters:
+      - description: The interface identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Interface'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get a specific interface record by its identifier.
+      tags:
+      - Interfaces
+    put:
+      operationId: interfaces_handleUpdatePut
+      parameters:
+      - description: The interface identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      - description: The interface data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.Interface'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Interface'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Update an interface record.
+      tags:
+      - Interfaces
+  /interface/new:
+    post:
+      operationId: interfaces_handleCreatePost
+      parameters:
+      - description: The interface data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.Interface'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Interface'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "409":
+          description: Conflict
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Create a new interface record.
+      tags:
+      - Interfaces
+  /metrics/by-interface/{id}:
+    get:
+      operationId: metrics_handleMetricsForInterfaceGet
+      parameters:
+      - description: The WireGuard interface identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.InterfaceMetrics'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all metrics for a WireGuard Portal interface.
+      tags:
+      - Metrics
+  /metrics/by-peer/{id}:
+    get:
+      operationId: metrics_handleMetricsForPeerGet
+      parameters:
+      - description: The peer identifier (public key).
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.PeerMetrics'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all metrics for a WireGuard Portal peer.
+      tags:
+      - Metrics
+  /metrics/by-user/{id}:
+    get:
+      operationId: metrics_handleMetricsForUserGet
+      parameters:
+      - description: The user identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.UserMetrics'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all metrics for a WireGuard Portal user.
+      tags:
+      - Metrics
+  /peer/by-id/{id}:
+    delete:
+      operationId: peers_handleDelete
+      parameters:
+      - description: The peer identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "204":
+          description: No content if deletion was successful.
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Delete the peer record.
+      tags:
+      - Peers
+    get:
+      description: Normal users can only access their own records. Admins can access
+        all records.
+      operationId: peers_handleByIdGet
+      parameters:
+      - description: The peer identifier (public key).
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Peer'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get a specific peer record by its identifier (public key).
+      tags:
+      - Peers
+    put:
+      description: Only admins can update existing records.
+      operationId: peers_handleUpdatePut
+      parameters:
+      - description: The peer identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      - description: The peer data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.Peer'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Peer'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Update a peer record.
+      tags:
+      - Peers
+  /peer/by-interface/{id}:
+    get:
+      operationId: peers_handleAllForInterfaceGet
+      parameters:
+      - description: The WireGuard interface identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/models.Peer'
+            type: array
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all peer records for a given WireGuard interface.
+      tags:
+      - Peers
+  /peer/by-user/{id}:
+    get:
+      description: Normal users can only access their own records. Admins can access
+        all records.
+      operationId: peers_handleAllForUserGet
+      parameters:
+      - description: The user identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/models.Peer'
+            type: array
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all peer records for a given user.
+      tags:
+      - Peers
+  /peer/new:
+    post:
+      description: Only admins can create new records.
+      operationId: peers_handleCreatePost
+      parameters:
+      - description: The peer data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.Peer'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Peer'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "409":
+          description: Conflict
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Create a new peer record.
+      tags:
+      - Peers
+  /provisioning/data/peer-config:
+    get:
+      description: Normal users can only access their own record. Admins can access
+        all records.
+      operationId: provisioning_handlePeerConfigGet
+      parameters:
+      - description: The peer identifier (public key) that should be queried.
+        in: query
+        name: PeerId
+        required: true
+        type: string
+      produces:
+      - text/plain
+      - application/json
+      responses:
+        "200":
+          description: The WireGuard configuration file
+          schema:
+            type: string
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get the peer configuration in wg-quick format.
+      tags:
+      - Provisioning
+  /provisioning/data/peer-qr:
+    get:
+      description: Normal users can only access their own record. Admins can access
+        all records.
+      operationId: provisioning_handlePeerQrGet
+      parameters:
+      - description: The peer identifier (public key) that should be queried.
+        in: query
+        name: PeerId
+        required: true
+        type: string
+      produces:
+      - image/png
+      - application/json
+      responses:
+        "200":
+          description: The WireGuard configuration QR code
+          schema:
+            type: file
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get the peer configuration as QR code.
+      tags:
+      - Provisioning
+  /provisioning/data/user-info:
+    get:
+      description: Normal users can only access their own record. Admins can access
+        all records.
+      operationId: provisioning_handleUserInfoGet
+      parameters:
+      - description: The user identifier that should be queried. If not set, the authenticated
+          user is used.
+        in: query
+        name: UserId
+        type: string
+      - description: The email address that should be queried. If UserId is set, this
+          is ignored.
+        in: query
+        name: Email
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.UserInformation'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get information about all peer records for a given user.
+      tags:
+      - Provisioning
+  /provisioning/new-peer:
+    post:
+      description: Normal users can only create new peers if self provisioning is
+        allowed. Admins can always add new peers.
+      operationId: provisioning_handleNewPeerPost
+      parameters:
+      - description: Provisioning request model.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.ProvisioningRequest'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.Peer'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Create a new peer for the given interface and user.
+      tags:
+      - Provisioning
+  /user/all:
+    get:
+      operationId: users_handleAllGet
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            items:
+              $ref: '#/definitions/models.User'
+            type: array
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get all user records.
+      tags:
+      - Users
+  /user/by-id/{id}:
+    delete:
+      operationId: users_handleDelete
+      parameters:
+      - description: The user identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "204":
+          description: No content if deletion was successful.
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Delete the user record.
+      tags:
+      - Users
+    get:
+      description: Normal users can only access their own record. Admins can access
+        all records.
+      operationId: users_handleByIdGet
+      parameters:
+      - description: The user identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.User'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Get a specific user record by its internal identifier.
+      tags:
+      - Users
+    put:
+      description: Only admins can update existing records.
+      operationId: users_handleUpdatePut
+      parameters:
+      - description: The user identifier.
+        in: path
+        name: id
+        required: true
+        type: string
+      - description: The user data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.User'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.User'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Update a user record.
+      tags:
+      - Users
+  /user/new:
+    post:
+      description: Only admins can create new records.
+      operationId: users_handleCreatePost
+      parameters:
+      - description: The user data.
+        in: body
+        name: request
+        required: true
+        schema:
+          $ref: '#/definitions/models.User'
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/models.User'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/models.Error'
+        "401":
+          description: Unauthorized
+          schema:
+            $ref: '#/definitions/models.Error'
+        "403":
+          description: Forbidden
+          schema:
+            $ref: '#/definitions/models.Error'
+        "409":
+          description: Conflict
+          schema:
+            $ref: '#/definitions/models.Error'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/models.Error'
+      security:
+      - BasicAuth: []
+      summary: Create a new user record.
+      tags:
+      - Users
+securityDefinitions:
+  BasicAuth:
+    type: basic
+swagger: "2.0"
