Difference between revisions of "Offerit REST API Remove Global Void Ip"

Revision as of 13:43, 5 August 2022

POST /config/remove_global_void_ip

Description

• The api/config/remove_global_void_ip action adds a valid ip to the Config->Security->Global Postback Allowed IPs

Resource URL

• https://domain/api/config/remove_global_void_ip
• Replace domain with the Offerit domain

Request Method

• POST

Response Format

• JSON

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

https://domain/api/config/remove_global_void_ip

• Response:

{
    "result": "success",
    "data": "Ip removed /  not in list / list not set"
}

{
    "result": "error",
    "data": "Invalid ip"
}

Example Code

PHP

<?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);
?>