⚙️API Integration
Panel

Networks

4min

Use those APIs to add Static IPs, Ranges, and Dynamic networks.

✨To Add a different Profiles to an existing Network, please add the same Network with a different Profile ID.

✨To Delete a specific Profile from an existing Network, call the delete APIs with the profile you want to remove.

Get the list of the Customer's Network
GET
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer

Add a Static WAN IP (IPv4 / IPv6). LAN IPs are not allowed.
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
ip
required
String
Static IPv4 / IPv6

Remove a Static IP (IPv4 / IPv6)
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
ip
required
String
Static IPv4 / IPv6

Add a Static Range IP (IPv4 only) LAN IPs are not allowed.
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
ip_from
required
String
Start IP (IPv4 only)
ip_to
required
String
End IP (IPv4 only)

Remove a Static IP Range (IPv4) LAN IPs are not allowed.
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
ip_from
required
String
Start IP (IPv4 only)
ip_to
required
String
End IP (IPv4 only)

Add a Dynamic Network with an optional NetworkDevice
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
username
required
String
Network DyDNS Username.
password
required
String
Password of the Dynamic Network, requested to update the IP. Needs to be between 8-16 chars, only Dollar Sign ($) is accepted as special char.
device_id
optional
Number
NetworkDevice ID, may be a Mikrotik Over VPN or a different device type. Use the device/list endpoint to list all the available NetworkDevices.
lang
optional
String
Lang code (in ES,DE,FR,PT,IT,EN) Required only if device_id is sent.

Delete a Dynamic Network
POST
Request
Header Parameters
X-API-KEY
required
String
Your API Key
Body Parameters
customer_code
required
Integer
ID of the Customer
profile_code
required
Integer
ID of the Profile
username
required
String
Network username




Updated 06 Sep 2024
Doc contributor
Did this page help you?