API: IP-address manager
From BrainyCP
Revision as of 13:08, 26 July 2021 by Alenka (talk | contribs) (Protected "API: IP-address manager" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.
Incoming data marked with an asterisk are required.
| Module |
Function |
Incoming data |
Error variants |
|
ipmanager |
List ipv4. listipv4ipm |
username (post or get) * - username; password (post or get) * - user password; ipmanager (post or get) * - constant, module name; listipv4ipm (post or get) * - constant, operation name.
|
error: 0, mess: 'The list of IP addresses was received successfully'; error: 1, mess: 'An error occurred while getting the list of IP addresses'; error: 1003, mess: 'You do not have administrator rights'.
|
|
ipmanager |
List ipv6. listipv6ipm |
username (post or get) * - username; password (post or get) * - user password; ipmanager (post or get) * - constant, module name; listipv6ipm (post or get) * - constant, operation name.
|
error: 0, mess: 'The list of IP addresses was received successfully'; error: 1, mess: 'An error occurred while getting the list of IP addresses'; error: 1003, mess: 'You do not have administrator rights'.
|
|
ipmanager |
Add ip. addipm |
username (post or get) * - username; password (post or get) * - user password; ipmanager (post or get) * - constant, module name; addipm (post or get) * - constant, operation name; ip_net (post or get) * - ip address of vip4 or vip6; netmask (post or get) * - subnet mask; gateway (post or get) * - gateway.
|
error: 0, mess: 'New IP address was added successfully'; error: 1, mess: 'An error occurred while adding an IP address'; error: 2, mess: 'The specified IP address is invalid'; error: 3, mess: 'The specified mask is invalid'; error: 4, mess: 'The specified gateway is invalid'; error: 1003, mess: 'You do not have administrator rights'.
|
|
ipmanager |
Delete ip. delipm |
username (post or get) * - username; password (post or get) * - user password; ipmanager (post or get) * - constant, module name; delipm (post or get) * - constant, operation name; ip_net (post or get) * - ip address of vip4 or vip6.
|
error: 0, mess: 'The IP address was deleted successfully'; error: 1, mess: 'An error occurred while deleting the IP address'; error: 2, mess: 'The specified IP address is invalid'; error: 1003, mess: 'You do not have
|
Other useful articles:
