2025-06-29 17:49:35 +00:00
<!doctype html> < html lang = en class = no-js > < head >< meta charset = utf-8 >< meta name = viewport content = "width=device-width,initial-scale=1" >< meta name = description content = "Manage WireGuard Peers and Interface using a beautiful and simple web UI." >< link href = https://wgportal.org/master/documentation/usage/webhooks/ rel = canonical >< link href = ../security/ rel = prev >< link href = ../../rest-api/api-doc/ rel = next >< link rel = icon href = ../../../assets/images/favicon-large.png >< meta name = generator content = "mkdocs-1.6.1, mkdocs-material-9.6.14" >< title > Webhooks - WireGuard Portal</ title >< link rel = stylesheet href = ../../../assets/stylesheets/main.342714a4.min.css >< link rel = stylesheet href = ../../../assets/stylesheets/palette.06af60db.min.css >< link rel = stylesheet href = ../../../stylesheets/extra.css >< 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 property = og:type content = website >< meta property = og:title content = "Webhooks - WireGuard Portal" >< meta property = og:description content = "Manage WireGuard Peers and Interface using a beautiful and simple web UI." >< meta property = og:image content = https://wgportal.org/master/assets/images/social/documentation/usage/webhooks.png >< meta property = og:image:type content = image/png >< meta property = og:image:width content = 1200 >< meta property = og:image:height content = 630 >< meta content = https://wgportal.org/master/documentation/usage/webhooks/ property = og:url >< meta name = twitter:card content = summary_large_image >< meta name = twitter:title content = "Webhooks - WireGuard Portal" >< meta name = twitter:description content = "Manage WireGuard Peers and Interface using a beautiful and simple web UI." >< meta name = twitter:image content = https://wgportal.org/master/assets/images/social/documentation/usage/webhooks.png ></ head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = white data-md-color-accent = indigo > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer ></ label > < div data-md-component = skip > < a href = #configuration class = md-skip > Skip to content </ a > </ 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 class = "md-header__inner md-grid" aria-label = Header > < a href = ../../.. title = "WireGuard Portal" class = "md-header__button md-logo" aria-label = "WireGuard Portal" data-md-component = logo > < img src = ../../../assets/images/logo.svg alt = logo > </ a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" >< path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" /></ 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 > Webhooks </ span > </ div > </ div > </ div > < label class = "md-header__button md-icon" for = __search > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" >< 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" /></ 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 type = text class = md-search__input name = query aria-label = Search placeholder = Search autocapitalize = off autocorrect = off autocomplete = off spellcheck = false data-md-component = search-query required > < label class = "md-search__icon md-icon" for = __sear
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = nt > url</ span >< span class = p > :</ span >< span class = w > </ span >< span class = "l l-Scalar l-Scalar-Plain" > https://your-service.example.com/webhook</ span >
</ code ></ pre ></ div > < h3 id = security > Security</ h3 > < p > Webhooks can be secured by using a shared secret. This secret is included in the < code > Authorization</ code > header of the webhook request, allowing your service to verify the authenticity of the request. You can set the shared secret in the webhook configuration:</ p > < div class = highlight >< pre >< span ></ span >< code >< span class = nt > webhook</ span >< span class = p > :</ span >
< span class = w > </ span >< span class = nt > url</ span >< span class = p > :</ span >< span class = w > </ span >< span class = "l l-Scalar l-Scalar-Plain" > https://your-service.example.com/webhook</ span >
< span class = w > </ span >< span class = nt > secret</ span >< span class = p > :</ span >< span class = w > </ span >< span class = s > " Basic</ span >< span class = nv > </ span >< span class = s > dXNlcm5hbWU6cGFzc3dvcmQ=" </ span >
2025-06-29 17:49:35 +00:00
</ code ></ pre ></ div > < p > You should also make sure that your webhook endpoint is secured with HTTPS to prevent eavesdropping and tampering.</ p > < h2 id = available-events > Available Events</ h2 > < p > WireGuard Portal supports various events that can trigger webhooks. The following events are available:</ p > < ul > < li >< code > create</ code > : Triggered when a new entity is created.</ li > < li >< code > update</ code > : Triggered when an existing entity is updated.</ li > < li >< code > delete</ code > : Triggered when an entity is deleted.</ li > < li >< code > connect</ code > : Triggered when a user connects to the VPN.</ li > < li >< code > disconnect</ code > : Triggered when a user disconnects from the VPN.</ li > </ ul > < p > The following entity models are supported for webhook events:</ p > < ul > < li >< code > user</ code > : WireGuard Portal users support creation, update, or deletion events.</ li > < li >< code > peer</ code > : Peers support creation, update, or deletion events. Via the < code > peer_metric</ code > entity, you can also receive connection status updates.</ li > < li >< code > peer_metric</ code > : Peer metrics support connection status updates, such as when a peer connects or disconnects.</ li > < li >< code > interface</ code > : WireGuard interfaces support creation, update, or deletion events.</ li > </ ul > < h2 id = payload-structure > Payload Structure</ h2 > < p > All webhook events send a JSON payload containing relevant data. The structure of the payload depends on the event type and entity involved. A common shell structure for webhook payloads is as follows:</ p > < div class = highlight >< pre >< span ></ span >< code >< span class = p > {</ span >
< span class = w > </ span >< span class = nt > " event" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " create" </ span >< span class = p > ,</ span >< span class = w > </ span >< span class = c1 > // The event type, e.g. " create" , " update" , " delete" , " connect" , " disconnect" </ span >
< span class = w > </ span >< span class = nt > " entity" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " user" </ span >< span class = p > ,</ span >< span class = w > </ span >< span class = c1 > // The entity type, e.g. " user" , " peer" , " peer_metric" , " interface" </ span >
< span class = w > </ span >< span class = nt > " identifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " the-user-identifier" </ span >< span class = p > ,</ span >< span class = w > </ span >< span class = c1 > // Unique identifier of the entity, e.g. user ID or peer ID</ span >
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = nt > " payload" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > {</ span >
2025-06-29 17:49:35 +00:00
< span class = w > </ span >< span class = c1 > // The payload of the event, e.g. a Peer model.</ span >
< span class = w > </ span >< span class = c1 > // Detailed model descriptions are provided below.</ span >
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = p > }</ span >
< span class = p > }</ span >
2025-06-29 17:49:35 +00:00
</ code ></ pre ></ div > < h3 id = payload-models > Payload Models</ h3 > < p > All payload models are encoded as JSON objects. Fields with empty values might be omitted in the payload.</ p > < h4 id = user-payload-entity-user > User Payload (entity: < code > user</ code > )</ h4 > < table > < thead > < tr > < th > JSON Field</ th > < th > Type</ th > < th > Description</ th > </ tr > </ thead > < tbody > < tr > < td > CreatedBy</ td > < td > string</ td > < td > Creator identifier</ td > </ tr > < tr > < td > UpdatedBy</ td > < td > string</ td > < td > Last updater identifier</ td > </ tr > < tr > < td > CreatedAt</ td > < td > time.Time</ td > < td > Time of creation</ td > </ tr > < tr > < td > UpdatedAt</ td > < td > time.Time</ td > < td > Time of last update</ td > </ tr > < tr > < td > Identifier</ td > < td > string</ td > < td > Unique user identifier</ td > </ tr > < tr > < td > Email</ td > < td > string</ td > < td > User email</ td > </ tr > < tr > < td > Source</ td > < td > string</ td > < td > Authentication source</ td > </ tr > < tr > < td > ProviderName</ td > < td > string</ td > < td > Name of auth provider</ td > </ tr > < tr > < td > IsAdmin</ td > < td > bool</ td > < td > Whether user has admin privileges</ td > </ tr > < tr > < td > Firstname</ td > < td > string</ td > < td > User's first name (optional)</ td > </ tr > < tr > < td > Lastname</ td > < td > string</ td > < td > User's last name (optional)</ td > </ tr > < tr > < td > Phone</ td > < td > string</ td > < td > Contact phone number (optional)</ td > </ tr > < tr > < td > Department</ td > < td > string</ td > < td > User's department (optional)</ td > </ tr > < tr > < td > Notes</ td > < td > string</ td > < td > Additional notes (optional)</ td > </ tr > < tr > < td > Disabled</ td > < td > *time.Time</ td > < td > When user was disabled</ td > </ tr > < tr > < td > DisabledReason</ td > < td > string</ td > < td > Reason for deactivation</ td > </ tr > < tr > < td > Locked</ td > < td > *time.Time</ td > < td > When user account was locked</ td > </ tr > < tr > < td > LockedReason</ td > < td > string</ td > < td > Reason for being locked</ td > </ tr > </ tbody > </ table > < h4 id = peer-payload-entity-peer > Peer Payload (entity: < code > peer</ code > )</ h4 > < table > < thead > < tr > < th > JSON Field</ th > < th > Type</ th > < th > Description</ th > </ tr > </ thead > < tbody > < tr > < td > CreatedBy</ td > < td > string</ td > < td > Creator identifier</ td > </ tr > < tr > < td > UpdatedBy</ td > < td > string</ td > < td > Last updater identifier</ td > </ tr > < tr > < td > CreatedAt</ td > < td > time.Time</ td > < td > Creation timestamp</ td > </ tr > < tr > < td > UpdatedAt</ td > < td > time.Time</ td > < td > Last update timestamp</ td > </ tr > < tr > < td > Endpoint</ td > < td > string</ td > < td > Peer endpoint address</ td > </ tr > < tr > < td > EndpointPublicKey</ td > < td > string</ td > < td > Public key of peer endpoint</ td > </ tr > < tr > < td > AllowedIPsStr</ td > < td > string</ td > < td > Allowed IPs</ td > </ tr > < tr > < td > ExtraAllowedIPsStr</ td > < td > string</ td > < td > Extra allowed IPs</ td > </ tr > < tr > < td > PresharedKey</ td > < td > string</ td > < td > Pre-shared key for encryption</ td > </ tr > < tr > < td > PersistentKeepalive</ td > < td > int</ td > < td > Keepalive interval in seconds</ td > </ tr > < tr > < td > DisplayName</ td > < td > string</ td > < td > Display name of the peer</ td > </ tr > < tr > < td > Identifier</ td > < td > string</ td > < td > Unique identifier</ td > </ tr > < tr > < td > UserIdentifier</ td > < td > string</ td > < td > Associated user ID (optional)</ td > </ tr > < tr > < td > InterfaceIdentifier</ td > < td > string</ td > < td > Interface this peer is attached to</ td > </ tr > < tr > < td > Disabled</ td > < td > *time.Time</ td > < td > When the peer was disabled</ td > </ tr > < tr > < td > DisabledReason</ td > < td > string</ td > < td > Reason for being disabled</ td > </ tr > < tr > < td > ExpiresAt</ td > < td > *time.Time</ td > < td > Expiration date</ td > </ tr > < tr > < td > Notes</ td > < td > string</ td > < td > Notes for this peer</ td > </ tr > < tr > < td > AutomaticallyCreated</ td > < td > bool</ td > < td > Whether peer was auto-generated</ td > </ tr > < tr > < td > PrivateKey</ td > < td > string</ td > < td > Peer private key</ td > </ tr > < tr > < td > PublicKey</ td > < td > string</ td > < td > Peer public key</ td > </ tr > < tr > < td > InterfaceType</ td > < td > string</ td > < td > Type of the peer interface</ td > </ tr > < tr > < td > Addresses</ td > < td > []string</ td > < td > IP addresses</ td > </ tr > < tr > < td > CheckAliveAddress</ td > < td > string</ td > < td > Address used for alive checks</ td > </ tr > < tr > < td > DnsStr</ td > < td > string</ td > < td > DNS servers</ td > </ tr > < tr > < td > DnsSearchStr</ td > < td > string</ td > < td > DNS search domains</ td > </ tr > < tr > < td > Mtu< /
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = nt > " event" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " connect" </ span >< span class = p > ,</ span >
2025-06-29 17:49:35 +00:00
< span class = w > </ span >< span class = nt > " entity" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " peer_metric" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " identifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " payload" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > {</ span >
< span class = w > </ span >< span class = nt > " Status" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > {</ span >
< span class = w > </ span >< span class = nt > " UpdatedAt" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-27T22:20:08.734900034+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " IsConnected" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = kc > true</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " IsPingable" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = kc > false</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " BytesReceived" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 212</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " BytesTransmitted" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 2884</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Endpoint" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 10.55.66.77:58756" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " LastHandshake" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-27T22:19:46.580842776+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " LastSessionStart" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-27T22:19:46.580842776+02:00" </ span >
< span class = w > </ span >< span class = p > },</ span >
< span class = w > </ span >< span class = nt > " Peer" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > {</ span >
< span class = w > </ span >< span class = nt > " CreatedBy" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UpdatedBy" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " CreatedAt" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-26T21:43:49.251839574+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UpdatedAt" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-27T22:18:39.67763985+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Endpoint" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 10.55.66.1:51820" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " EndpointPublicKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " eiVibpi3C2PUPcx2kwA5s09OgHx7AEaKMd33k0LQ5mM=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " AllowedIPsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 10.11.12.0/24,fdfd:d3ad:c0de:1234::/64" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " ExtraAllowedIPsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PresharedKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " p9DDeLUSLOdQcjS8ZsBAiqUzwDIUvTyzavRZFuzhvyE=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PersistentKeepalive" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 16</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DisplayName" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Peer Fb5TaziA" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Identifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UserIdentifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " InterfaceIdentifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " wgTesting" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " AutomaticallyCreated" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = kc > false</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PrivateKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " QBFNBe+7J49ergH0ze2TGUJMFrL/2bOL50Z2cgluYW8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PublicKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " InterfaceType" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " client" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Addresses" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > [</ span >
< span class = w > </ span >< span class = s2 > " 10.11.12.10/32" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = s2 > " fdfd:d3ad:c0de:1234::a/128" </ span >
< span class = w > </ span >< span class = p > ],</ span >
< span class = w > </ span >< span class = nt > " CheckAliveAddress" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DnsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DnsSearchStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Mtu" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 1420</ span >
< span class = w > </ span >< span class = p > }</ span >
< span class = w > </ span >< span class = p > }</ span >
< span class = p > }</ span >
</ code ></ pre ></ div > < p > Here is another example of a webhook event when a peer is updated:</ p > < div class = highlight >< pre >< span ></ span >< code >< span class = p > {</ span >
< span class = w > </ span >< span class = nt > " event" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " update" </ span >< span class = p > ,</ span >
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = nt > " entity" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " peer" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " identifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " payload" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > {</ span >
2025-06-29 17:49:35 +00:00
< span class = w > </ span >< span class = nt > " CreatedBy" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UpdatedBy" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " CreatedAt" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-26T21:43:49.251839574+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UpdatedAt" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 2025-06-27T22:18:39.67763985+02:00" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Endpoint" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 10.55.66.1:51820" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " EndpointPublicKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " eiVibpi3C2PUPcx2kwA5s09OgHx7AEaKMd33k0LQ5mM=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " AllowedIPsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " 10.11.12.0/24,fdfd:d3ad:c0de:1234::/64" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " ExtraAllowedIPsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PresharedKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " p9DDeLUSLOdQcjS8ZsBAiqUzwDIUvTyzavRZFuzhvyE=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PersistentKeepalive" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 16</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DisplayName" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Peer Fb5TaziA" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Identifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " UserIdentifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " admin@wgportal.local" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " InterfaceIdentifier" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " wgTesting" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " AutomaticallyCreated" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = kc > false</ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PrivateKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " QBFNBe+7J49ergH0ze2TGUJMFrL/2bOL50Z2cgluYW8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " PublicKey" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " Fb5TaziAs1WrPBjC/MFbWsIelVXvi0hDKZ3YQM9wmU8=" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " InterfaceType" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > " client" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Addresses" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = p > [</ span >
< span class = w > </ span >< span class = s2 > " 10.11.12.10/32" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = s2 > " fdfd:d3ad:c0de:1234::a/128" </ span >
< span class = w > </ span >< span class = p > ],</ span >
< span class = w > </ span >< span class = nt > " CheckAliveAddress" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DnsStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " DnsSearchStr" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = s2 > "" </ span >< span class = p > ,</ span >
< span class = w > </ span >< span class = nt > " Mtu" </ span >< span class = p > :</ span >< span class = w > </ span >< span class = mi > 1420</ span >
2025-06-27 10:37:43 +00:00
< span class = w > </ span >< span class = p > }</ span >
< span class = p > }</ span >
</ code ></ pre ></ div > </ 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/ target = _blank rel = noopener style = "color: black;" > Material for MkDocs </ a > </ div > </ div > <!-- Social links --> < div class = md-social > < a href = https://github.com/h44z/wg-portal target = _blank rel = noopener title = github.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 480 512" > <!-- 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" /></ svg > </ a > < a href = https://hub.docker.com/r/wgportal/wg-portal target = _blank rel = noopener title = hub.docker.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 640 512" > <!-- 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" /></ svg > </ a > < a href = https://twitter.com/chris_h44z target = _blank rel = noopener title = twitter.com class = md-social__link > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 512 512" > <!-- 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 . 83
