- Overview
- Getting Started
- Glossary
- Where to start?
- What does agent-client mean?
- Resource monitoring
- Reseller webhooks
- Installation
- Generating VPN accounts
- User Guide
- Best Practices
- Integrations
- APIs for User
- APIs for Reseller
- Users
- Notifications
- VPN
- GET API-keys info GET
- GET news GET
- Get servers list GET
- Webhook for RevenueCatPOST
- User Stories and Use Cases
- Video Tutorials and Walkthroughs
- Troubleshooting
- Contact and Support
Get vpn servers config
GET
/reseller/user/{UUID}/vpn/{code}
Info for resellers
Request
Path Params
UUID
string
required
Example:
44b51ff9-88ac-40ec-845e-34d4eb39b790
code
string
required
Example:
openvpn
Query Params
out
enum<string>
required
Allowed values:
jsonzip
cfg
enum<string>
optional
Allowed values:
minimalfull
ip
string
optional
Example:
8.8.8.8
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://test.your-api-server.com/reseller/user/44b51ff9-88ac-40ec-845e-34d4eb39b790/vpn/openvpn?out'
Responses
🟢200Success
application/json
Body
ca_certificate
string
required
Example:
-----BEGIN CERTIFICATE-----
MIIB1jCCAX2gAwIBAgIUZwTRH44z6DyNa9R5tjr5T8L3guIwCgYIKoZIzj0EAwIw
HjEcMBoGA1UEAwwTY25fRkFuNEdyNkdHWEZRSGtPRTAeFw0yMjA3MDExMTI0MTNa
Fw0zMjA2MjgxMTI0MTNaMB4xHDAaBgNVBAMME2NuX0ZBbjRHcjZHR1hGUUhrT0Uw
WTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAARV8AClmlA0JRd3PB+J4AtCH2HWHXf2
42q8VrgwbxoT0UpeiNVT8ya+l47l5nrZdzGxn2EH7knlnKoXuLIGIYi7o4GYMIGV
MB0GA1UdDgQWBBRa9u8/HSUdL5e1wPDNiRalKfOO7TBZBgNVHSMEUjBQgBRa9u8/
HSUdL5e1wPDNiRalKfOO7aEipCAwHjEcMBoGA1UEAwwTY25fRkFuNEdyNkdHWEZR
SGtPRYIUZwTRH44z6DyNa9R5tjr5T8L3guIwDAYDVR0TBAUwAwEB/zALBgNVHQ8E
BAMCAQYwCgYIKoZIzj0EAwIDRwAwRAIgBOL8//X1O9ywrHAKTFfxpdRV2zgXWxS9
VSxmPD9aAhACICq6r4plvnaxt7BRxXaN1RYeDuqn7mrSR4/MK2t9xXxH
-----END CERTIFICATE-----
servers
array[string]
required
Example:
[{"_id":"62fcb75a45410a023eaf39b5","ip":"185.186.245.45","country":{"code":"NL","name":"Netherland"},"location":"Amsterdam","latitude":52.3676,"longitude":4.9041,"user_cert":"-----BEGIN CERTIFICATE-----MIIB4zCCAYigAwIBAgIQfWECthihUugIiEpOconC5zAKBggqhkjOPQQDAjAeMRwwGgYDVQQDDBNjbl9GQW40R3I2R0dYRlFIa09FMB4XDTIyMDcwMTExMjQyOVoXDTI0MTAwMzExMjQyOVowGzEZMBcGA1UEAwwQTkwxLVRFU1QtY2xpZW50MTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABNjcoOi7hBl1V3PUpFqYskuvGyQd6kbrddY/Btnc+2/YjPDjATCUB+cb2kROJSGTqkrf9wMIgojtuHYK9DetOOejgaowgacwCQYDVR0TBAIwADAdBgNVHQ4EFgQUvx8+h030j+EySAYR1uaa3Cyy2JowWQYDVR0jBFIwUIAUWvbvPx0lHS+XtcDwzYkWpSnzju2hIqQgMB4xHDAaBgNVBAMME2NuX0ZBbjRHcjZHR1hGUUhrT0WCFGcE0R+OM+g8jWvUebY6+U/C94LiMBMGA1UdJQQMMAoGCCsGAQUFBwMCMAsGA1UdDwQEAwIHgDAKBggqhkjOPQQDAgNJADBGAiEAxIJIcy4+T7NRWNYbkAtY6bDrOUYeZVYLkLiOHKOIlWICIQCyA21s4Qc9DBP5DPbrDfQvWj+xmpuP+ibuzyEf/9mIWA==-----END CERTIFICATE-----","config_raw":"#socket buffer size\nremote 185.186.245.45 1194\nsndbuf 262144\nrcvbuf 262144\n\r\n#DNS server to use\ndhcp-option DNS 1.1.1.1\n\r\n#remove to use your ISP's gateway\nredirect-gateway def1\n\r\n#your access keys\nca in_ca.crt\ncert in_69565798793919.crt\nkey in_69565798793919.key\nns-cert-type server\n\r\n#cipher to use\ncipher AES-256-CBC\n\r\n#use virtual interface 'tap'\ndev tap\n\r\n#keep trying indefinitely to resolve the host name of the OpenVPN server.\nresolv-retry infinite\n\r\n#most clients don't need to bind to a specific local port number.\nnobind\r\n\r\n#try to preserve some state across restarts\npersist-key\r\npersist-tun\r\n\r\n#enable compression on the VPN link\ncomp-lzo\r\n\r\n#set log file verbosity.\nverb 4\n\r\n#silence repeating messages\nmute 20\n\r\n#tell the server to immediately close its client instance object rather than waiting for a timeout\nexplicit-exit-notify\r\n\r\n#Windows specific\nwin-sys 'env'\nroute-method exe\nroute-delay 3\n<key>\r\n-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgLtjCexwdXNoMg57m\r\nkrUpwS3p84WlAg3/EkAmev8ge9ahRANCAATY3KDou4QZdVdz1KRamLJLrxskHepG\r\n63XWPwbZ3Ptv2Izw4wEwlAfnG9pETiUhk6pK3/cDCIKI7bh2CvQ3rTjn\r\n-----END PRIVATE KEY-----\r\n</key>\n\n#Extra params\n<ca>\r\n-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgLtjCexwdXNoMg57m\r\nkrUpwS3p84WlAg3/EkAmev8ge9ahRANCAATY3KDou4QZdVdz1KRamLJLrxskHepG\r\n63XWPwbZ3Ptv2Izw4wEwlAfnG9pETiUhk6pK3/cDCIKI7bh2CvQ3rTjn\r\n-----END PRIVATE KEY-----\r\n</ca>\n\n"},{"ip":"92.38.178.135","country":{"code":"JP","name":"Japan"},"location":"Tokyo","latitude":35.652832,"longitude":139.839478,"config_raw":"[Interface]\nAddress = 10.50.0.5/16\nPrivateKey = SDkVHMJmZN+5Awi1Sw6nOpNfAAbuEA6lfmobwb8iFXQ=\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = 3tsoOnSp12DUd310yjzapSobcBapCKfBYOL21TiI+Hc=\nAllowedIPs = 0.0.0.0/5, 8.0.0.0/7, 11.0.0.0/8, 12.0.0.0/6, 16.0.0.0/4, 32.0.0.0/3, 64.0.0.0/2, 128.0.0.0/3, 160.0.0.0/5, 168.0.0.0/6, 172.0.0.0/12, 172.32.0.0/11, 172.64.0.0/10, 172.128.0.0/9, 173.0.0.0/8, 174.0.0.0/7, 176.0.0.0/4, 192.0.0.0/9, 192.128.0.0/11, 192.160.0.0/13, 192.169.0.0/16, 192.170.0.0/15, 192.172.0.0/14, 192.176.0.0/12, 192.192.0.0/10, 193.0.0.0/8, 194.0.0.0/7, 196.0.0.0/6, 200.0.0.0/5, 208.0.0.0/4, 8.8.8.8/32, 192.168.10.0/24\nEndpoint = 92.38.178.135:51820","config_object":{"wgInterface":{"address":["10.10.1.1"],"privateKey":"6AgToMLuTa3lQMIMwIBVkhwSM0PVLCZD1FpqU5y0l2Q","name":"Client 1"},"peers":[{"allowedIps":["10.10.1.1"],"publicKey":"FoSq0MiHw9nuHMiJcD2vPCzQScmn1Hu0ctfKfSfhp3s="}]}}]
Example
{
"ca_certificate": "-----BEGIN CERTIFICATE-----\r\nMIIB1jCCAX2gAwIBAgIUZwTRH44z6DyNa9R5tjr5T8L3guIwCgYIKoZIzj0EAwIw\r\nHjEcMBoGA1UEAwwTY25fRkFuNEdyNkdHWEZRSGtPRTAeFw0yMjA3MDExMTI0MTNa\r\nFw0zMjA2MjgxMTI0MTNaMB4xHDAaBgNVBAMME2NuX0ZBbjRHcjZHR1hGUUhrT0Uw\r\nWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAARV8AClmlA0JRd3PB+J4AtCH2HWHXf2\r\n42q8VrgwbxoT0UpeiNVT8ya+l47l5nrZdzGxn2EH7knlnKoXuLIGIYi7o4GYMIGV\r\nMB0GA1UdDgQWBBRa9u8/HSUdL5e1wPDNiRalKfOO7TBZBgNVHSMEUjBQgBRa9u8/\r\nHSUdL5e1wPDNiRalKfOO7aEipCAwHjEcMBoGA1UEAwwTY25fRkFuNEdyNkdHWEZR\r\nSGtPRYIUZwTRH44z6DyNa9R5tjr5T8L3guIwDAYDVR0TBAUwAwEB/zALBgNVHQ8E\r\nBAMCAQYwCgYIKoZIzj0EAwIDRwAwRAIgBOL8//X1O9ywrHAKTFfxpdRV2zgXWxS9\r\nVSxmPD9aAhACICq6r4plvnaxt7BRxXaN1RYeDuqn7mrSR4/MK2t9xXxH\r\n-----END CERTIFICATE-----",
"servers": [
{
"_id": "62fcb75a45410a023eaf39b5",
"ip": "185.186.245.45",
"country": {
"code": "NL",
"name": "Netherland"
},
"location": "Amsterdam",
"latitude": 52.3676,
"longitude": 4.9041,
"user_cert": "-----BEGIN CERTIFICATE-----MIIB4zCCAYigAwIBAgIQfWECthihUugIiEpOconC5zAKBggqhkjOPQQDAjAeMRwwGgYDVQQDDBNjbl9GQW40R3I2R0dYRlFIa09FMB4XDTIyMDcwMTExMjQyOVoXDTI0MTAwMzExMjQyOVowGzEZMBcGA1UEAwwQTkwxLVRFU1QtY2xpZW50MTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABNjcoOi7hBl1V3PUpFqYskuvGyQd6kbrddY/Btnc+2/YjPDjATCUB+cb2kROJSGTqkrf9wMIgojtuHYK9DetOOejgaowgacwCQYDVR0TBAIwADAdBgNVHQ4EFgQUvx8+h030j+EySAYR1uaa3Cyy2JowWQYDVR0jBFIwUIAUWvbvPx0lHS+XtcDwzYkWpSnzju2hIqQgMB4xHDAaBgNVBAMME2NuX0ZBbjRHcjZHR1hGUUhrT0WCFGcE0R+OM+g8jWvUebY6+U/C94LiMBMGA1UdJQQMMAoGCCsGAQUFBwMCMAsGA1UdDwQEAwIHgDAKBggqhkjOPQQDAgNJADBGAiEAxIJIcy4+T7NRWNYbkAtY6bDrOUYeZVYLkLiOHKOIlWICIQCyA21s4Qc9DBP5DPbrDfQvWj+xmpuP+ibuzyEf/9mIWA==-----END CERTIFICATE-----",
"config_raw": "#socket buffer size\nremote 185.186.245.45 1194\nsndbuf 262144\nrcvbuf 262144\n\r\n#DNS server to use\ndhcp-option DNS 1.1.1.1\n\r\n#remove to use your ISP's gateway\nredirect-gateway def1\n\r\n#your access keys\nca in_ca.crt\ncert in_69565798793919.crt\nkey in_69565798793919.key\nns-cert-type server\n\r\n#cipher to use\ncipher AES-256-CBC\n\r\n#use virtual interface 'tap'\ndev tap\n\r\n#keep trying indefinitely to resolve the host name of the OpenVPN server.\nresolv-retry infinite\n\r\n#most clients don't need to bind to a specific local port number.\nnobind\r\n\r\n#try to preserve some state across restarts\npersist-key\r\npersist-tun\r\n\r\n#enable compression on the VPN link\ncomp-lzo\r\n\r\n#set log file verbosity.\nverb 4\n\r\n#silence repeating messages\nmute 20\n\r\n#tell the server to immediately close its client instance object rather than waiting for a timeout\nexplicit-exit-notify\r\n\r\n#Windows specific\nwin-sys 'env'\nroute-method exe\nroute-delay 3\n<key>\r\n-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgLtjCexwdXNoMg57m\r\nkrUpwS3p84WlAg3/EkAmev8ge9ahRANCAATY3KDou4QZdVdz1KRamLJLrxskHepG\r\n63XWPwbZ3Ptv2Izw4wEwlAfnG9pETiUhk6pK3/cDCIKI7bh2CvQ3rTjn\r\n-----END PRIVATE KEY-----\r\n</key>\n\n#Extra params\n<ca>\r\n-----BEGIN PRIVATE KEY-----\r\nMIGHAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBG0wawIBAQQgLtjCexwdXNoMg57m\r\nkrUpwS3p84WlAg3/EkAmev8ge9ahRANCAATY3KDou4QZdVdz1KRamLJLrxskHepG\r\n63XWPwbZ3Ptv2Izw4wEwlAfnG9pETiUhk6pK3/cDCIKI7bh2CvQ3rTjn\r\n-----END PRIVATE KEY-----\r\n</ca>\n\n"
},
{
"ip": "92.38.178.135",
"country": {
"code": "JP",
"name": "Japan"
},
"location": "Tokyo",
"latitude": 35.652832,
"longitude": 139.839478,
"config_raw": "[Interface]\nAddress = 10.50.0.5/16\nPrivateKey = SDkVHMJmZN+5Awi1Sw6nOpNfAAbuEA6lfmobwb8iFXQ=\nDNS = 1.1.1.1\n\n[Peer]\nPublicKey = 3tsoOnSp12DUd310yjzapSobcBapCKfBYOL21TiI+Hc=\nAllowedIPs = 0.0.0.0/5, 8.0.0.0/7, 11.0.0.0/8, 12.0.0.0/6, 16.0.0.0/4, 32.0.0.0/3, 64.0.0.0/2, 128.0.0.0/3, 160.0.0.0/5, 168.0.0.0/6, 172.0.0.0/12, 172.32.0.0/11, 172.64.0.0/10, 172.128.0.0/9, 173.0.0.0/8, 174.0.0.0/7, 176.0.0.0/4, 192.0.0.0/9, 192.128.0.0/11, 192.160.0.0/13, 192.169.0.0/16, 192.170.0.0/15, 192.172.0.0/14, 192.176.0.0/12, 192.192.0.0/10, 193.0.0.0/8, 194.0.0.0/7, 196.0.0.0/6, 200.0.0.0/5, 208.0.0.0/4, 8.8.8.8/32, 192.168.10.0/24\nEndpoint = 92.38.178.135:51820",
"config_object": {
"wgInterface": {
"address": [
"10.10.1.1"
],
"privateKey": "6AgToMLuTa3lQMIMwIBVkhwSM0PVLCZD1FpqU5y0l2Q",
"name": "Client 1"
},
"peers": [
{
"allowedIps": [
"10.10.1.1"
],
"publicKey": "FoSq0MiHw9nuHMiJcD2vPCzQScmn1Hu0ctfKfSfhp3s="
}
]
}
}
]
}
🟠400400
🟠401401
🟠403403
🟠404404