Offeritnick: /* POST /config/remove_global_post_ip */

2022-08-26T19:48:19Z

‎POST /config/remove_global_post_ip

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_post_ip''' == '''Description''' *The api/config/remove_global_post_ip action removes a pro..."

2022-08-08T17:51:47Z

Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_post_ip''' == '''Description''' *The api/config/remove_global_post_ip action removes a pro..."

New page

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_post_ip''' ==
'''Description'''
*The api/config/remove_global_post_ip action removes a provided ip from the Config -> Security, Global Host and Post Allowed IPs

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_global_post_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/remove_global_post_ip</nowiki>

*Response:
<pre>
{
"result": "success",
"data": "Ip removed / not in list / list not set"
}

{
"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/remove_global_post_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]]

@@ Line 4: / Line 4: @@
 == '''POST /config/remove_global_post_ip''' ==
 '''Description'''
-*The api/config/remove_global_post_ip action removes a provided ip from the Config -> Security, Global Host and Post Allowed IPs
+*The api/config/remove_global_post_ip action removes a provided ip from the Config -> Security, Global Postback Allowed IPs
 '''Resource URL'''

Offerit REST API Remove Global Post Ip - Revision history

Offeritnick: /* POST /config/remove_global_post_ip */

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''POST /config/remove_global_post_ip''' == '''Description''' *The api/config/remove_global_post_ip action removes a pro..."