fbpx
Search
Close this search box.
Search
Close this search box.

< / >

APIs Configuration

9. Add IP

URL:

https://wv{{wolvox_server}}.wolkvox.com/api/v2/configuration.php?api=add_ip

Description:

This API allows you to enter IP to the server’s firewall to enable it to perform actions on it.

Benefit:

Quickly add the IPs of your users or servers to our firewall to allow execution of actions.

How it works:

  • The consumption of this API is done by POST method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.

REQUEST

NAME DESCRIPTION TYPE
ip IPv4 address to be added in the module String
permanent Specifies whether the IP to enter is permanent or temporary. This field accepts the values “yes” and “no”. If no value is sent, the default will be “no”. There is a maximum of 5 permanent IPs per operation. String
description Description of the added api String

RESPONSE

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response String

Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolvox_server}}.wolkvox.com/api/v2/configuration.php?api=add_ip',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "ip": "",
    "permanent": "",
   "description": ""
}
',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "201",
    "error": null,
    "msg": "IP: XXX.XXX.XXX.XXX has been added successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data