Business CommunityControllersQuestion: how to add new peer to WireGuard VPN via API
Controllers

Question: how to add new peer to WireGuard VPN via API

12

Question: how to add new peer to WireGuard VPN via API

Question: how to add new peer to WireGuard VPN via API
Question: how to add new peer to WireGuard VPN via API
2026-03-13 18:12:55 - last edited a week ago
Tags: #API #VPN
Model: Omada Software Controller (Windows)  
Hardware Version:
Firmware Version: 6.2.0.15

hi all,

 

i have a question: how can I add neww / edit peer for WireGuard VPN?

 

 

/BR ZoloNN ----------------------------------------------------------------------- Omada 2x ER605(UN) v2.0 + SG2008P(UN) V3.20 + SG2218 V1.20 + 2x SG2008 V4.20 + 3x EAP615-Wall(EU) V1.0 CET (GMT+1)
0
0
#1
1 Accepted Solution
Re:Question: how to add new peer to WireGuard VPN via API-Solution
a week ago - last edited a week ago

Hi  @ZoloNN 

 

Sorry for the late reply. Here are the intructions:

  1. Use this API to retrieve existing wired guard VPNs and related peer parameters: GET /openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/{vpnId}
  2. Based on the above information, identify the VPN ID to be modified and the existing parameter details. Then use the following PATCH method to add corresponding peer information (i.e., remote subset): PATCH /openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/{vpnId}

 

 

Error -1001 Invalid request parameters indicates that the parameters are unavailable. It is likely that the input information was not formatted as required. Please check whether the parameters are complete and formatted in accordance with the document requirements.

 

If the situation is still the same, don't hesitate to let us know.

Wish you a happy life and smooth network usage!  >Get the Latest Omada SDN Controller Releases Here< >Get the Latest Firmware Releases for Omada Routers Here< >Experience the Latest Omada EAP Firmware<
Recommended Solution
0
0
#13
14 Reply
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-17 07:43:03

Hi  @ZoloNN 

You may refer to the following guide: How to configure Wireguard VPN on Omada Gateway

Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
0
0
#2
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-17 08:59:46

Hi @Hank21,

 

sorry, but you probably missed the important "via API" part of my question...

 

/BR ZoloNN ----------------------------------------------------------------------- Omada 2x ER605(UN) v2.0 + SG2008P(UN) V3.20 + SG2218 V1.20 + 2x SG2008 V4.20 + 3x EAP615-Wall(EU) V1.0 CET (GMT+1)
0
0
#3
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-18 10:21:25

Hi  @ZoloNN 

Sorry for the missing.

You may login your Controller and find the OpenAPI entrance under Global View>Settings>Platform Integration. With that, you can try to search something about the peer of Wireguard VPN.

Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
0
0
#4
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-18 17:40:32

Hi @Hank21,

 

yes, I know the documentation page.

There is a section called "WireGuard" and there is a call called "Create new wireguard peer" but the whole section is currently deprecated.

According the docu the replacement should be the "Modify site-to-site VPN by manual", but in the description there isn't anything about modifying only the peer list.

My every try to modify the existing record ends with error "-1001 Invalid request parameters"......

 

/BR ZoloNN ----------------------------------------------------------------------- Omada 2x ER605(UN) v2.0 + SG2008P(UN) V3.20 + SG2218 V1.20 + 2x SG2008 V4.20 + 3x EAP615-Wall(EU) V1.0 CET (GMT+1)
0
0
#5
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-20 03:51:51

Hi  @ZoloNN 

You can refer to this link: Omada Open Api

The wireguard VPN option is moved to site settings, so you can try to add the peer from that entrance.

Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
0
0
#6
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-23 15:52:43

Hi @Hank21, 

 

I've tried your link - under assumption that "Released Versions" are referring to Controller version I run into strange problem:

If I go to "6.2.0" version and I try to open the 04 Site Setting.html, it opens only a page template which isn't populated. Other pages are working fine.....

template

 

And while accessing the API docs via "Platform Integration" the whole WireGuard section (except key generation call) is marked as deprecated - is it really true?

deprecated

 

 

/BR ZoloNN ----------------------------------------------------------------------- Omada 2x ER605(UN) v2.0 + SG2008P(UN) V3.20 + SG2218 V1.20 + 2x SG2008 V4.20 + 3x EAP615-Wall(EU) V1.0 CET (GMT+1)
0
0
#7
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-27 08:11:53 - last edited 2026-03-31 07:29:09

Hi  @ZoloNN 

Please try to download the 6.2 Omada Software Controller and try to use it buili-in OpenAPI for the Wiregurad peer feature:

https://community.tp-link.com/en/business/forum/topic/857494

Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
0
0
#8
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-27 10:08:07 - last edited 2026-03-27 10:09:41

Hi @Hank21,

 

just to summarize:

  • I already use Windows based Controller version 6.2.0.15 (as seen in properties of my first post)
  • opening API docu via Global -> Settings -> Platform Intergration -> Online API Document the whole WireGuard section is marked deprecated (as seen on screenshot in my previous post)
  • there is recommended to use the "Modify site-to-site VPN by manual" call, but I'm struggling to use this call to add peer to existing VPN - my every try to modify the existing record ends with error "-1001 Invalid request parameters"......
  • opening alternative API docu via link provided by you shows blank template page for Site Settings (as seen on screenshot in my previous post)

 

my questions are:

  • are the WireGuard API calls really deprecated?
  • if yes, where can I find more detailed description how to modify (add new peer) VPN record via "Modify site-to-site VPN by manual" call?
  • why is the page for Site Settings in alternative docu blank (template only)?

 

 

/BR ZoloNN ----------------------------------------------------------------------- Omada 2x ER605(UN) v2.0 + SG2008P(UN) V3.20 + SG2218 V1.20 + 2x SG2008 V4.20 + 3x EAP615-Wall(EU) V1.0 CET (GMT+1)
0
0
#9
Re:Question: how to add new peer to WireGuard VPN via API
2026-03-30 03:13:11

Hi  @ZoloNN 

The Version 6.2 of Omada software Controller has the features you want on Wireguard VPN peer adding, you can try to download it and try to configure with the link provided before.

If the Software Controller has the same issue with unconfigurable page, please feel free to provide the screenshot for our reference.

 

Best Regards! >> Omada EAP Firmware Trial Available Here << >> Get the Latest Omada SDN Controller Releases Here << *Try filtering posts on each forum by Label of [Early Access]*
0
0
#10
Re:Question: how to add new peer to WireGuard VPN via API
3 weeks ago - last edited 3 weeks ago

Hi  @ZoloNN 

 

As noted in the document, please use the site-to-site VPN interface information.

This is because in versions 6.0/6.1, the VPN status entry is integrated into a fixed page: Insight → VPN Status, and the VPN status originally in the Dashboard has also been merged here.

 

So please refer to the guide on this page:

 

 

Wish you a happy life and smooth network usage!  >Get the Latest Omada SDN Controller Releases Here< >Get the Latest Firmware Releases for Omada Routers Here< >Experience the Latest Omada EAP Firmware<
0
0
#11
12

Information

Helpful: 0

Views: 726

Replies: 14

Tags

API VPN
About Us
Press
Copyright © TP-Link Systems Inc. All rights reserved.