Threat Intelligence Open API

BlwlN

delBlwlFile

Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted.


/{feed_type}/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlNApi;

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

public class BlwlNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#delBlwlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlNApi;

public class BlwlNApiExample {

    public static void main(String[] args) {
        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#delBlwlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance delBlwlFileWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlNApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with a single column for server.

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delBlwlFile(feedType, feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delBlwlFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlNApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.delBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlNApi.delBlwlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlNApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->delBlwlFile($feedType, $feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlNApi->delBlwlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlNApi;

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

my $api_instance = WWW::SwaggerClient::BlwlNApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->delBlwlFile(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlNApi->delBlwlFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlNApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.del_blwl_file(feedType, feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlNApi->delBlwlFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with a single column for server.
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


getBlwlFile

Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.


/{feed_type}/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlNApi;

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

public class BlwlNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getBlwlFile(feedType, feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#getBlwlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlNApi;

public class BlwlNApiExample {

    public static void main(String[] args) {
        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getBlwlFile(feedType, feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#getBlwlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance getBlwlFileWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(valid_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlNApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlwlFile(feedType, feedContentType, feedName, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBlwlFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlNApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                valid_response result = apiInstance.getBlwlFile(feedType, feedContentType, feedName, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlNApi.getBlwlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlNApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->getBlwlFile($feedType, $feedContentType, $feedName, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlNApi->getBlwlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlNApi;

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

my $api_instance = WWW::SwaggerClient::BlwlNApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->getBlwlFile(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlNApi->getBlwlFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlNApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.get_blwl_file(feedType, feedContentType, feedName, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlNApi->getBlwlFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String

Responses

Status: 200 - Get the processing status of the feed.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


patchBlwlFile

Updates an IP/URL/DOMAIN in a given feed.


/{feed_type}/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlNApi;

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

public class BlwlNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#patchBlwlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlNApi;

public class BlwlNApiExample {

    public static void main(String[] args) {
        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#patchBlwlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance patchBlwlFileWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlNApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with a single column for server.

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchBlwlFile(feedType, feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchBlwlFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlNApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.patchBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlNApi.patchBlwlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlNApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->patchBlwlFile($feedType, $feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlNApi->patchBlwlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlNApi;

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

my $api_instance = WWW::SwaggerClient::BlwlNApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->patchBlwlFile(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlNApi->patchBlwlFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlNApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.patch_blwl_file(feedType, feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlNApi->patchBlwlFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with a single column for server.
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


postBlwlFile

Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.


/{feed_type}/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlNApi;

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

public class BlwlNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#postBlwlFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlNApi;

public class BlwlNApiExample {

    public static void main(String[] args) {
        BlwlNApi apiInstance = new BlwlNApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlNApi#postBlwlFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance postBlwlFileWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlNApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with a single column for server.

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postBlwlFile(feedType, feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postBlwlFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlNApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.postBlwlFile(feedType, feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlNApi.postBlwlFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlNApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->postBlwlFile($feedType, $feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlNApi->postBlwlFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlNApi;

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

my $api_instance = WWW::SwaggerClient::BlwlNApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->postBlwlFile(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlNApi->postBlwlFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlNApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.post_blwl_file(feedType, feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlNApi->postBlwlFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with a single column for server.
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


BlwlOne

delBlwlParam

Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.


/{feed_type}/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlOneApi;

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

public class BlwlOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#delBlwlParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlOneApi;

public class BlwlOneApiExample {

    public static void main(String[] args) {
        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#delBlwlParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance delBlwlParamWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlOneApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delBlwlParam(feedType, feedContentType, feedName, server, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delBlwlParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlOneApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.delBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlOneApi.delBlwlParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlOneApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->delBlwlParam($feedType, $feedContentType, $feedName, $server, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlOneApi->delBlwlParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlOneApi;

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

my $api_instance = WWW::SwaggerClient::BlwlOneApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->delBlwlParam(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, server => $server, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlOneApi->delBlwlParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlOneApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.del_blwl_param(feedType, feedContentType, feedName, server, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlOneApi->delBlwlParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


getBlwlParam

Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.


/{feed_type}/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlOneApi;

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

public class BlwlOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getBlwlParam(feedType, feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#getBlwlParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlOneApi;

public class BlwlOneApiExample {

    public static void main(String[] args) {
        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getBlwlParam(feedType, feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#getBlwlParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance getBlwlParamWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(valid_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlOneApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlwlParam(feedType, feedContentType, feedName, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBlwlParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlOneApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                valid_response result = apiInstance.getBlwlParam(feedType, feedContentType, feedName, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlOneApi.getBlwlParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlOneApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->getBlwlParam($feedType, $feedContentType, $feedName, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlOneApi->getBlwlParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlOneApi;

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

my $api_instance = WWW::SwaggerClient::BlwlOneApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->getBlwlParam(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlOneApi->getBlwlParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlOneApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.get_blwl_param(feedType, feedContentType, feedName, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlOneApi->getBlwlParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String

Responses

Status: 200 - Get the processing status of the feed.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


patchBlwlParam

Updates an IP/URL/DOMAIN in a given feed.


/{feed_type}/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlOneApi;

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

public class BlwlOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#patchBlwlParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlOneApi;

public class BlwlOneApiExample {

    public static void main(String[] args) {
        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#patchBlwlParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance patchBlwlParamWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlOneApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchBlwlParam(feedType, feedContentType, feedName, server, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchBlwlParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlOneApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.patchBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlOneApi.patchBlwlParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlOneApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->patchBlwlParam($feedType, $feedContentType, $feedName, $server, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlOneApi->patchBlwlParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlOneApi;

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

my $api_instance = WWW::SwaggerClient::BlwlOneApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->patchBlwlParam(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, server => $server, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlOneApi->patchBlwlParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlOneApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.patch_blwl_param(feedType, feedContentType, feedName, server, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlOneApi->patchBlwlParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


postBlwlParam

Inject an IP/URL/DOMAIN into BL or WL feed. Subsequent POST with same feed name will throw an error.


/{feed_type}/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/{feed_type}/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BlwlOneApi;

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

public class BlwlOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#postBlwlParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BlwlOneApi;

public class BlwlOneApiExample {

    public static void main(String[] args) {
        BlwlOneApi apiInstance = new BlwlOneApi();
        String feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BlwlOneApi#postBlwlParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedType = feedType_example; // Type of feed. Blacklist or Whitelist.
String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance postBlwlParamWith:feedType
    feedContentType:feedContentType
    feedName:feedName
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.BlwlOneApi()

var feedType = feedType_example; // {String} Type of feed. Blacklist or Whitelist.

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postBlwlParam(feedType, feedContentType, feedName, server, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postBlwlParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BlwlOneApi();
            var feedType = feedType_example;  // String | Type of feed. Blacklist or Whitelist.
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.postBlwlParam(feedType, feedContentType, feedName, server, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BlwlOneApi.postBlwlParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\BlwlOneApi();
$feedType = feedType_example; // String | Type of feed. Blacklist or Whitelist.
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->postBlwlParam($feedType, $feedContentType, $feedName, $server, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BlwlOneApi->postBlwlParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BlwlOneApi;

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

my $api_instance = WWW::SwaggerClient::BlwlOneApi->new();
my $feedType = feedType_example; # String | Type of feed. Blacklist or Whitelist.
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->postBlwlParam(feedType => $feedType, feedContentType => $feedContentType, feedName => $feedName, server => $server, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BlwlOneApi->postBlwlParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.BlwlOneApi()
feedType = feedType_example # String | Type of feed. Blacklist or Whitelist.
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.post_blwl_param(feedType, feedContentType, feedName, server, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BlwlOneApi->postBlwlParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_type*
String
Type of feed. Blacklist or Whitelist.
Required
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


CcN

delCcFile

Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted.


/cc/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcNApi;

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

public class CcNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#delCcFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcNApi;

public class CcNApiExample {

    public static void main(String[] args) {
        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#delCcFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance delCcFileWith:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcNApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with a single column for server.

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delCcFile(feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delCcFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcNApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.delCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcNApi.delCcFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcNApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->delCcFile($feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcNApi->delCcFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcNApi;

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

my $api_instance = WWW::SwaggerClient::CcNApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->delCcFile(feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcNApi->delCcFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcNApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.del_cc_file(feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcNApi->delCcFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with a single column for server.
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


getCcFile

Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.


/cc/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcNApi;

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

public class CcNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getCcFile(feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#getCcFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcNApi;

public class CcNApiExample {

    public static void main(String[] args) {
        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getCcFile(feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#getCcFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance getCcFileWith:feedContentType
    feedName:feedName
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(valid_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcNApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

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

namespace Example
{
    public class getCcFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcNApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                valid_response result = apiInstance.getCcFile(feedContentType, feedName, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcNApi.getCcFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcNApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->getCcFile($feedContentType, $feedName, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcNApi->getCcFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcNApi;

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

my $api_instance = WWW::SwaggerClient::CcNApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->getCcFile(feedContentType => $feedContentType, feedName => $feedName, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcNApi->getCcFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcNApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.get_cc_file(feedContentType, feedName, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcNApi->getCcFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String

Responses

Status: 200 - Get the processing status of the feed.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


patchCcFile

Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.


/cc/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcNApi;

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

public class CcNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with columns 
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#patchCcFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcNApi;

public class CcNApiExample {

    public static void main(String[] args) {
        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with columns 
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#patchCcFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with columns 
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance patchCcFileWith:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcNApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with columns 

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchCcFile(feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchCcFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcNApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with columns 
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.patchCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcNApi.patchCcFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcNApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with columns 
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->patchCcFile($feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcNApi->patchCcFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcNApi;

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

my $api_instance = WWW::SwaggerClient::CcNApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with columns 
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->patchCcFile(feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcNApi->patchCcFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcNApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with columns 
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.patch_cc_file(feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcNApi->patchCcFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with columns <server, threat_level>
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


postCcFile

Inject an IP/URL/DOMAIN into CC feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.


/cc/file/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/file/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcNApi;

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

public class CcNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with columns 
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#postCcFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcNApi;

public class CcNApiExample {

    public static void main(String[] args) {
        CcNApi apiInstance = new CcNApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with columns 
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcNApi#postCcFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with columns 
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance postCcFileWith:feedContentType
    feedName:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcNApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with columns 

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postCcFile(feedContentType, feedName, file, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postCcFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcNApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with columns 
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.postCcFile(feedContentType, feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcNApi.postCcFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcNApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with columns 
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->postCcFile($feedContentType, $feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcNApi->postCcFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcNApi;

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

my $api_instance = WWW::SwaggerClient::CcNApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with columns 
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->postCcFile(feedContentType => $feedContentType, feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcNApi->postCcFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcNApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with columns 
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.post_cc_file(feedContentType, feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcNApi->postCcFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with columns <server, threat_level>
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


CcOne

delCcParam

Delete the provided entry from the feed. If no IP/URL/DOMAIN is provided, the entire feed will be deleted. Pass server name as *, to delete the entire feed.


/cc/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcOneApi;

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

public class CcOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delCcParam(feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#delCcParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcOneApi;

public class CcOneApiExample {

    public static void main(String[] args) {
        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delCcParam(feedContentType, feedName, server, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#delCcParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance delCcParamWith:feedContentType
    feedName:feedName
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcOneApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delCcParam(feedContentType, feedName, server, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class delCcParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcOneApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.delCcParam(feedContentType, feedName, server, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcOneApi.delCcParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcOneApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->delCcParam($feedContentType, $feedName, $server, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcOneApi->delCcParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcOneApi;

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

my $api_instance = WWW::SwaggerClient::CcOneApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->delCcParam(feedContentType => $feedContentType, feedName => $feedName, server => $server, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcOneApi->delCcParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcOneApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.del_cc_param(feedContentType, feedName, server, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcOneApi->delCcParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


getCcParam

Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.


/cc/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcOneApi;

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

public class CcOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getCcParam(feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#getCcParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcOneApi;

public class CcOneApiExample {

    public static void main(String[] args) {
        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getCcParam(feedContentType, feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#getCcParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance getCcParamWith:feedContentType
    feedName:feedName
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(valid_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcOneApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

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

namespace Example
{
    public class getCcParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcOneApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                valid_response result = apiInstance.getCcParam(feedContentType, feedName, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcOneApi.getCcParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcOneApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->getCcParam($feedContentType, $feedName, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcOneApi->getCcParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcOneApi;

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

my $api_instance = WWW::SwaggerClient::CcOneApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->getCcParam(feedContentType => $feedContentType, feedName => $feedName, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcOneApi->getCcParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcOneApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.get_cc_param(feedContentType, feedName, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcOneApi->getCcParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String

Responses

Status: 200 - Get the processing status of the feed.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


patchCcParam

Updates an IP/URL/DOMAIN in a given feed with a threat level between 1-10.


/cc/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcOneApi;

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

public class CcOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        Integer threatLevel = 56; // Integer | Threat level, ranging between 1-10.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#patchCcParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcOneApi;

public class CcOneApiExample {

    public static void main(String[] args) {
        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        Integer threatLevel = 56; // Integer | Threat level, ranging between 1-10.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.patchCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#patchCcParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Integer *threatLevel = 56; // Threat level, ranging between 1-10.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance patchCcParamWith:feedContentType
    feedName:feedName
    server:server
    threatLevel:threatLevel
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcOneApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var threatLevel = 56; // {Integer} Threat level, ranging between 1-10.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchCcParam(feedContentType, feedName, server, threatLevel, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class patchCcParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcOneApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var threatLevel = 56;  // Integer | Threat level, ranging between 1-10.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.patchCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcOneApi.patchCcParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcOneApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$threatLevel = 56; // Integer | Threat level, ranging between 1-10.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->patchCcParam($feedContentType, $feedName, $server, $threatLevel, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcOneApi->patchCcParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcOneApi;

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

my $api_instance = WWW::SwaggerClient::CcOneApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $threatLevel = 56; # Integer | Threat level, ranging between 1-10.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->patchCcParam(feedContentType => $feedContentType, feedName => $feedName, server => $server, threatLevel => $threatLevel, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcOneApi->patchCcParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcOneApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
threatLevel = 56 # Integer | Threat level, ranging between 1-10.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.patch_cc_param(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcOneApi->patchCcParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required
threat_level*
Integer
Threat level, ranging between 1-10.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


postCcParam

Inject an IP/URL/DOMAIN into CC feed with a threat level between 1-10. Subsequent POST with same feed name will throw an error.


/cc/param/{feed_content_type}/{feed_name}

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/cc/param/{feed_content_type}/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CcOneApi;

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

public class CcOneApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        Integer threatLevel = 56; // Integer | Threat level, ranging between 1-10.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#postCcParam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CcOneApi;

public class CcOneApiExample {

    public static void main(String[] args) {
        CcOneApi apiInstance = new CcOneApi();
        String feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
        String feedName = feedName_example; // String | Name of a feed.
        String server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
        Integer threatLevel = 56; // Integer | Threat level, ranging between 1-10.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.postCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CcOneApi#postCcParam");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedContentType = feedContentType_example; // Content type of the feed. Could be one of ip, url or domain.
String *feedName = feedName_example; // Name of a feed.
String *server = server_example; // IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Integer *threatLevel = 56; // Threat level, ranging between 1-10.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance postCcParamWith:feedContentType
    feedName:feedName
    server:server
    threatLevel:threatLevel
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.CcOneApi()

var feedContentType = feedContentType_example; // {String} Content type of the feed. Could be one of ip, url or domain.

var feedName = feedName_example; // {String} Name of a feed.

var server = server_example; // {String} IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.

var threatLevel = 56; // {Integer} Threat level, ranging between 1-10.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postCcParam(feedContentType, feedName, server, threatLevel, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postCcParamExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CcOneApi();
            var feedContentType = feedContentType_example;  // String | Content type of the feed. Could be one of ip, url or domain.
            var feedName = feedName_example;  // String | Name of a feed.
            var server = server_example;  // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
            var threatLevel = 56;  // Integer | Threat level, ranging between 1-10.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.postCcParam(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CcOneApi.postCcParam: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\CcOneApi();
$feedContentType = feedContentType_example; // String | Content type of the feed. Could be one of ip, url or domain.
$feedName = feedName_example; // String | Name of a feed.
$server = server_example; // String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
$threatLevel = 56; // Integer | Threat level, ranging between 1-10.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->postCcParam($feedContentType, $feedName, $server, $threatLevel, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CcOneApi->postCcParam: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CcOneApi;

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

my $api_instance = WWW::SwaggerClient::CcOneApi->new();
my $feedContentType = feedContentType_example; # String | Content type of the feed. Could be one of ip, url or domain.
my $feedName = feedName_example; # String | Name of a feed.
my $server = server_example; # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
my $threatLevel = 56; # Integer | Threat level, ranging between 1-10.
my $authorization = authorization_example; # String |
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->postCcParam(feedContentType => $feedContentType, feedName => $feedName, server => $server, threatLevel => $threatLevel, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CcOneApi->postCcParam: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CcOneApi()
feedContentType = feedContentType_example # String | Content type of the feed. Could be one of ip, url or domain.
feedName = feedName_example # String | Name of a feed.
server = server_example # String | IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
threatLevel = 56 # Integer | Threat level, ranging between 1-10.
authorization = authorization_example # String |
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.post_cc_param(feedContentType, feedName, server, threatLevel, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CcOneApi->postCcParam: %s\n" % e)

Parameters

Path parameters
Name Description
feed_content_type*
String
Content type of the feed. Could be one of ip, url or domain.
Required
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
server*
String
IP/URL/DOMAIN depending on the feed_content_type. IPv4 and IPv6 supported.
Required
threat_level*
Integer
Threat level, ranging between 1-10.
Required

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


Default

ping

Ping the API to determine if it is alive.


/ping

Usage and SDK Samples

curl -X GET "http://localhost/v2/cloudfeeds/ping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DefaultApi;

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

public class DefaultApiExample {

    public static void main(String[] args) {

        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.ping();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#ping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.ping();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#ping");
            e.printStackTrace();
        }
    }
}

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

// Ping the API to determine if it is alive.
[apiInstance pingWithCompletionHandler:
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');

var api = new ThreatIntelligenceOpenApi.DefaultApi()

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

namespace Example
{
    public class pingExample
    {
        public void main()
        {

            var apiInstance = new DefaultApi();

            try
            {
                // Ping the API to determine if it is alive.
                apiInstance.ping();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.ping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DefaultApi();

try {
    $api_instance->ping();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->ping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;

my $api_instance = WWW::SwaggerClient::DefaultApi->new();

eval {
    $api_instance->ping();
};
if ($@) {
    warn "Exception when calling DefaultApi->ping: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DefaultApi()

try:
    # Ping the API to determine if it is alive.
    api_instance.ping()
except ApiException as e:
    print("Exception when calling DefaultApi->ping: %s\n" % e)

Parameters

Responses

Status: 200 - Ping succeeded.


DnsN

delDnsFile

Delete the provided entry from the feed. If no DOMAIN is provided, the entire feed will be deleted.


/DNS/file/{feed_name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/DNS/file/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DnsNApi;

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

public class DnsNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        DnsNApi apiInstance = new DnsNApi();
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delDnsFile(feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DnsNApi#delDnsFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DnsNApi;

public class DnsNApiExample {

    public static void main(String[] args) {
        DnsNApi apiInstance = new DnsNApi();
        String feedName = feedName_example; // String | Name of a feed.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String |
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            Object result = apiInstance.delDnsFile(feedName, file, authorization, failOnError, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DnsNApi#delDnsFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedName = feedName_example; // Name of a feed.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; //
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance delDnsFileWith:feedName
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.DnsNApi()

var feedName = feedName_example; // {String} Name of a feed.

var file = /path/to/file.txt; // {File} csv file, with a single column for server.

var authorization = authorization_example; // {String}

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String}
};

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

namespace Example
{
    public class delDnsFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DnsNApi();
            var feedName = feedName_example;  // String | Name of a feed.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String |
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                Object result = apiInstance.delDnsFile(feedName, file, authorization, failOnError, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DnsNApi.delDnsFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\DnsNApi();
$feedName = feedName_example; // String | Name of a feed.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String |
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->delDnsFile($feedName, $file, $authorization, $failOnError, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DnsNApi->delDnsFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DnsNApi;

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

my $api_instance = WWW::SwaggerClient::DnsNApi->new();
my $feedName = feedName_example; # String | Name of a feed.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String |
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String |

eval {
    my $result = $api_instance->delDnsFile(feedName => $feedName, file => $file, authorization => $authorization, failOnError => $failOnError, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DnsNApi->delDnsFile: $@\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: Bearer
swagger_client.configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.DnsNApi()
feedName = feedName_example # String | Name of a feed.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String |
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String |  (optional)

try:
    api_response = api_instance.del_dns_file(feedName, file, authorization, failOnError=failOnError, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DnsNApi->delDnsFile: %s\n" % e)

Parameters

Path parameters
Name Description
feed_name*
String
Name of a feed.
Required
Header parameters
Name Description
Authorization*
String
Required
X-Forwarded-For
String
Form parameters
Name Description
file*
File
csv file, with a single column for server.
Required
failOnError
Boolean
Whether to partially process the file in case of parsing errors.

Responses

Status: 202 - The request has been accepted for processing.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

Status: 404 - Resource not found

Status: 409 - Request cannot be completed due to conflict.

Status: 422 - Unprocessable Entity. Input is syntactically correct but semantically incorrect.

Status: 429 - Client has sent too many requests in a given amount of time, API quota exceeded

Status: 500 - Internal server error

Status: 503 - Service is temporarily not available. The Retry-After response header will indicate how long the service is expected to be unavailable to the requesting client.


getDnsFile

Feed processing status from the processing engine. If there are any errors in processing, this API will return those as well.


/DNS/file/{feed_name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://localhost/v2/cloudfeeds/DNS/file/{feed_name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DnsNApi;

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

public class DnsNApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: Bearer
        ApiKeyAuth Bearer = (ApiKeyAuth) defaultClient.getAuthentication("Bearer");
        Bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Bearer.setApiKeyPrefix("Token");

        DnsNApi apiInstance = new DnsNApi();
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getDnsFile(feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DnsNApi#getDnsFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DnsNApi;

public class DnsNApiExample {

    public static void main(String[] args) {
        DnsNApi apiInstance = new DnsNApi();
        String feedName = feedName_example; // String | Name of a feed.
        String authorization = authorization_example; // String |
        String xForwardedFor = xForwardedFor_example; // String |
        try {
            valid_response result = apiInstance.getDnsFile(feedName, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DnsNApi#getDnsFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

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

String *feedName = feedName_example; // Name of a feed.
String *authorization = authorization_example; //
String *xForwardedFor = xForwardedFor_example; //  (optional)

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

[apiInstance getDnsFileWith:feedName
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(valid_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ThreatIntelligenceOpenApi = require('threat_intelligence_open_api');
var defaultClient = ThreatIntelligenceOpenApi.ApiClient.instance;

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

var api = new ThreatIntelligenceOpenApi.DnsNApi()

var feedName = feedName_example; // {String} Name of a feed.

var authorization = authorization_example; // {String}

var opts = {
  'xForwardedFor': xForwardedFor_example // {String}
};

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

namespace Example
{
    public class getDnsFileExample
    {
        public void main()
        {

            // Configure API key authorization: Bearer
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DnsNApi();
            var feedName = feedName_example;  // String | Name of a feed.
            var authorization = authorization_example;  // String |
            var xForwardedFor = xForwardedFor_example;  // String |  (optional)

            try
            {
                valid_response result = apiInstance.getDnsFile(feedName, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DnsNApi.getDnsFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

$api_instance = new Swagger\Client\Api\DnsNApi();
$feedName = feedName_example; // String | Name of a feed.
$authorization = authorization_example; // String |
$xForwardedFor = xForwardedFor_example; // String |

try {
    $result = $api_instance->getDnsFile($feedName, $authorization, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DnsNApi->getDnsFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DnsNApi;

# Configure API key authorization: Bearer
$WWW::SwaggerClient::Configurat