OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_void_ip''' == '''Description''' *The api/config/add_global_void_ip action adds a valid ip to..."

2022-08-01T21:57:23Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_void_ip''' == '''Description''' *The api/config/add_global_void_ip action adds a valid ip to..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_void_ip''' ==
'''Description'''
*The api/config/add_global_void_ip action adds a valid ip to the Config->Security->Global Void Ip list

'''Resource URL'''
*<nowiki>https://domain/api/config/add_global_void_ip</nowiki>
*Replace domain with the Offerit domain

'''[[Offerit_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*POST

'''Response Format'''
*JSON

'''[[Offerit_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==
'''Parameters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded'''

*ip
**'''''type: string'''''
**'''required'''
**ipv4 or ipv6 format

== '''Example Request''' ==

'''POST'''

<nowiki>https://domain/api/config/add_global_void_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip added / Ip already in list"
}

{
"result": "error",
"data": "Invalid ip"
}
</pre>

== '''Example Code''' ==

'''PHP'''
<pre>
<?php
$curl = curl_init();

$data = array(
'ip' => '73.279.112.30',
);

$url = 'https://domain/api/config/add_global_void_ip';

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url);

$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
</pre>

[[Category:Offerit API Articles]]

Offerit REST API Add Global Void Ip - Revision history

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/add_global_void_ip''' == '''Description''' *The api/config/add_global_void_ip action adds a valid ip to..."