Blacklist IP API Documentation

CheckIP

checkIP

Check if an IP is blacklisted


/ipv4/{ip}

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/blacklist-ip/ipv4/{ip}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CheckIPApi;

import java.io.File;
import java.util.*;

public class CheckIPApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        CheckIPApi apiInstance = new CheckIPApi();
        String apiecoKey = apiecoKey_example; // String | Pet object that needs to be added to the store
        String ip = ip_example; // String | 
        try {
            inline_response_200 result = apiInstance.checkIP(apiecoKey, ip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckIPApi#checkIP");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CheckIPApi;

public class CheckIPApiExample {

    public static void main(String[] args) {
        CheckIPApi apiInstance = new CheckIPApi();
        String apiecoKey = apiecoKey_example; // String | Pet object that needs to be added to the store
        String ip = ip_example; // String | 
        try {
            inline_response_200 result = apiInstance.checkIP(apiecoKey, ip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CheckIPApi#checkIP");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *apiecoKey = apiecoKey_example; // Pet object that needs to be added to the store
String *ip = ip_example; // 

CheckIPApi *apiInstance = [[CheckIPApi alloc] init];

// 
[apiInstance checkIPWith:apiecoKey
    ip:ip
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var BlacklistIpApiDocumentation = require('blacklist_ip_api_documentation');
var defaultClient = BlacklistIpApiDocumentation.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new BlacklistIpApiDocumentation.CheckIPApi()

var apiecoKey = apiecoKey_example; // {String} Pet object that needs to be added to the store

var ip = ip_example; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkIP(apiecoKey, ip, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class checkIPExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new CheckIPApi();
            var apiecoKey = apiecoKey_example;  // String | Pet object that needs to be added to the store
            var ip = ip_example;  // String | 

            try
            {
                // 
                inline_response_200 result = apiInstance.checkIP(apiecoKey, ip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CheckIPApi.checkIP: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\CheckIPApi();
$apiecoKey = apiecoKey_example; // String | Pet object that needs to be added to the store
$ip = ip_example; // String | 

try {
    $result = $api_instance->checkIP($apiecoKey, $ip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CheckIPApi->checkIP: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CheckIPApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CheckIPApi->new();
my $apiecoKey = apiecoKey_example; # String | Pet object that needs to be added to the store
my $ip = ip_example; # String | 

eval { 
    my $result = $api_instance->checkIP(apiecoKey => $apiecoKey, ip => $ip);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CheckIPApi->checkIP: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CheckIPApi()
apiecoKey = apiecoKey_example # String | Pet object that needs to be added to the store
ip = ip_example # String | 

try: 
    # 
    api_response = api_instance.check_ip(apiecoKey, ip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CheckIPApi->checkIP: %s\n" % e)

Parameters

Path parameters
Name Description
ip*
String
Required
Header parameters
Name Description
apieco-key*
String
Pet object that needs to be added to the store
Required

Responses

Status: 200 - Successful

Status: 405 - Invalid input