Offerit - New pages [en]

Offerit REST API Remove Global Post Ip

2022-08-08T17:51:47Z

Offeritnick: /* POST /config/remove_global_post_ip */

{{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 Postback 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]]

Offerit REST API Remove Global Host and Post Ips

2022-08-08T17:18:34Z

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

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/remove_global_hostnpost_ip''' ==
'''Description'''
*The api/config/remove_global_hostnpost_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_hostnpost_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_hostnpost_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_hostnpost_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 Remove Global Void Ip

2022-08-05T18:43:28Z

OfferitRob: /* POST /config/remove_global_void_ip */

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

'''Resource URL'''
*<nowiki>https://domain/api/config/remove_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/remove_global_void_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_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 Host and Post Ips

2022-08-03T22:33:59Z

OfferitRob: /* POST /config/add_global_hostnpost_ip */

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_hostnpost_ip''' ==
'''Description'''
*The api/config/add_global_hostnpost_ip action adds a valid ip to the Config->Security->Global Host and Post Allowed IPs

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

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

{
"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_hostnpost_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 Post Ip

2022-08-01T23:11:07Z

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

{{Offerit Manual
| show_rest_api_section = true
}}
== '''POST /config/add_global_post_ip''' ==
'''Description'''
*The api/config/add_global_post_ip action adds a valid ip to the Config->Security->Global Postback Allowed IPs

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

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

{
"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_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]]

Offerit REST API Add Global Void Ip

2022-08-01T21:57:23Z

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..."

{{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 Get Global Post Ips

2022-07-26T21:13:08Z

OfferitRob: Created page with "{{Offerit Manual | show_rest_api_section = true }} == '''GET /config/get_global_post_ips''' == '''Description''' *The api/config/get_global_post_ips action is allows retriev..."

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_post_ips''' ==
'''Description'''
*The api/config/get_global_post_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Postback Allowed IPs)

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

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

'''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'''

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

'''GET'''

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

*Response:
<pre>
{
"result": "success",
"data": [
"2001:1af8:4e00:a018:6::10",
"73.279.112.30"
]
}

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

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

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

$data = array();

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

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
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 Get Global Host and Post Ips

2022-07-26T21:11:10Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_hostnpost_ips''' ==
'''Description'''
*The api/config/get_global_hostnpost_ips action is allows retrieval of the Global Post Ip list (Config -> Security, Global Host and Post Allowed IPs)

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

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

'''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'''

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

'''GET'''

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

*Response:
<pre>
{
"result": "success",
"data": [
"2001:1af8:4e00:a018:6::10",
"73.279.112.30"
]
}

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

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

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

$data = array();

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

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
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 Get Global Void Ips

2022-07-22T18:08:39Z

OfferitRob:

{{Offerit Manual
| show_rest_api_section = true
}}
== '''GET /config/get_global_void_ips''' ==
'''Description'''
*The api/config/get_global_void_ips action allows retrieval of the "Global Void Allowed IPs" list set in Config -> Security

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

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

'''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'''

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

'''GET'''

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

*Response:
<pre>
true
</pre>

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

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

$data = array();

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

$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: offerit_admin'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
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>

'''Python'''
*This example requires pip and the request library which can be installed via pip by: 'pip install requests'
<pre>
import requests
import json

url = 'https://domain/api/config/get_global_void_ips'

payload = {}

headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}

res = requests.GET(url, data=payload, headers=headers)
print res.json()

</pre>

'''node.js'''
*This example requires npm and the request module which can be installed via npm by: 'npm install request'
<pre>
var request = require('request');

data = {}

var options = {
url: 'https://domain/api/config/get_global_void_ips',
method: 'GET',
form: data,
json: true,
headers: {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'offerit_admin'
}
};

function callback(error, response, body) {
if (!error && response.statusCode == 200) {
console.log(body);
}
else{
console.log(body);
}

}

request(options, callback);

</pre>

'''Curl'''
<pre>
curl -X GET 'https://domain/api/config/get_global_void_ips' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: offerit_admin" -H "Content-Type: application/x-www-form-urlencoded"
</pre>

[[Category:Offerit API Articles]]