Deleting Information

You can delete an IP filter group.

Request Interface

HTTP Request

DELETE /ip-filter/group/{ipFilterGroupName}

Parameter

Path Parameter

Value

Required

Description

Default Value

ipFilterGroupName

string

true

IP filter group name

-

Response Interface

If the request is processed successfully, the response body is not returned.

If the request is processed unsuccessfully, a response is returned in the following JSON format.

{
	"code": "xxxxxxx",
	"message": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"connectionIdList":[
		"connectionId1",
		"connectionId2"
	],
	"secondaryAccountList":[
		"connectionId1",
		"connectionId2"
	]
}
		

Property Name

Value

Description

code

string

Error code

message

string

Error message

connectionIdList

array

List of connection IDs that are using the ipFilterGroupName to be deleted

secondaryAccountList array List of secondary account that are using the ipFilterGroupName to be deleted

Examples

public static void main(String[] args) {
	String host = "https://www.webconnect.hulft.com";
	String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
	String ipFilterGroupName= "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
	try {
		URL url = new URL(host + "/api/v2/ip-filter/group/" + ipFilterGroupName);
		HttpURLConnection connection = (HttpURLConnection) url.openConnection();
		connection.setRequestMethod("DELETE");
		connection.setRequestProperty("Authorization", "Bearer " + apiKey);
		System.out.println(connection.getResponseMessage());
			 // The response does not contain the response body.
	} catch (IOException ex) {
	// error
	}
}

//load jquery 
var host = 'https://www.webconnect.hulft.com';
var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
var ipFilterGroupName = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
$.ajax({
  type: 'DELETE',
  url: host + '/api/v2/ip-filter/group/' + ipFilterGroupName ,
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});