Juniper ATP Cloud Open API

BlwlN

delBlwlFile

Delete given server in the list or the entire list if one of the entries in the file is * or all.


/{list_type}/file/{server_type}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/file/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.delBlwlFile(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.delBlwlFile(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance delBlwlFileWith:listType
    serverType:serverType
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlNApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

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

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delBlwlFile(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.delBlwlFile(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->delBlwlFile($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->delBlwlFile(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.del_blwl_file(listType, serverType, 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
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
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: 413 - Input file size over max limit.

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

Returns the blacklist/whitelist for the specific server type.


/{list_type}/file/{server_type}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/file/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            BlwlResult result = apiInstance.getBlwlFile(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            BlwlResult result = apiInstance.getBlwlFile(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance getBlwlFileWith:listType
    serverType:serverType
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(BlwlResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlNApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlwlFile(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                BlwlResult result = apiInstance.getBlwlFile(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->getBlwlFile($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->getBlwlFile(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

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

Parameters

Path parameters
Name Description
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.

Responses

Status: 200 - Get the blacklist/whitelist.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

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 a list of IP/URL/FQDN from a file in a specific list.


/{list_type}/file/{server_type}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/file/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.patchBlwlFile(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        File file = /path/to/file.txt; // File | csv file, with a single column for server.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.patchBlwlFile(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
File *file = /path/to/file.txt; // csv file, with a single column for server.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Boolean *failOnError = true; // Whether to partially process the file in case of parsing errors. (optional) (default to true)
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance patchBlwlFileWith:listType
    serverType:serverType
    file:file
    authorization:authorization
    failOnError:failOnError
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlNApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

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

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'failOnError': true, // {Boolean} Whether to partially process the file in case of parsing errors.
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchBlwlFile(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var file = new File(); // File | csv file, with a single column for server.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var failOnError = true;  // Boolean | Whether to partially process the file in case of parsing errors. (optional)  (default to true)
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.patchBlwlFile(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$file = /path/to/file.txt; // File | csv file, with a single column for server.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$failOnError = true; // Boolean | Whether to partially process the file in case of parsing errors.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->patchBlwlFile($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $file = /path/to/file.txt; # File | csv file, with a single column for server.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $failOnError = true; # Boolean | Whether to partially process the file in case of parsing errors.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->patchBlwlFile(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
file = /path/to/file.txt # File | csv file, with a single column for server.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
failOnError = true # Boolean | Whether to partially process the file in case of parsing errors. (optional) (default to true)
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.patch_blwl_file(listType, serverType, 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
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
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: 413 - Input file size over max limit.

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 given server in the feed or the entire feed. Pass server name as * or all, to delete the entire list.


/{list_type}/param/{server_type}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/param/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.delBlwlParam(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.delBlwlParam(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
String *server = server_example; // IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance delBlwlParamWith:listType
    serverType:serverType
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlOneApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

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

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.delBlwlParam(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var server = server_example;  // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.delBlwlParam(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->delBlwlParam($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $server = server_example; # String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->delBlwlParam(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
server = server_example # String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.del_blwl_param(listType, serverType, 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
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Form parameters
Name Description
server*
String
IP/URL/FQDN depending on the server_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: 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

Returns the blacklist/whitelist for the specific server type.


/{list_type}/param/{server_type}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/param/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            BlwlResult result = apiInstance.getBlwlParam(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            BlwlResult result = apiInstance.getBlwlParam(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance getBlwlParamWith:listType
    serverType:serverType
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(BlwlResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlOneApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlwlParam(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                BlwlResult result = apiInstance.getBlwlParam(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->getBlwlParam($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->getBlwlParam(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

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

Parameters

Path parameters
Name Description
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.

Responses

Status: 200 - Get the blacklist/whitelist.

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

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/FQDN in a blacklist/whitelist


/{list_type}/param/{server_type}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/{list_type}/param/{server_type}"
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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.patchBlwlParam(listType, serverType, 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 listType = listType_example; // String | Type of list, blacklist or whitelist.
        String serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
        String server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.patchBlwlParam(listType, serverType, 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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *serverType = serverType_example; // Server type of the list. Could be one of ip, url or domain.
String *server = server_example; // IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance patchBlwlParamWith:listType
    serverType:serverType
    server:server
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.BlwlOneApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var serverType = serverType_example; // {String} Server type of the list. Could be one of ip, url or domain.

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

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchBlwlParam(listType, serverType, 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 listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var serverType = serverType_example;  // String | Server type of the list. Could be one of ip, url or domain.
            var server = server_example;  // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.patchBlwlParam(listType, serverType, 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();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$serverType = serverType_example; // String | Server type of the list. Could be one of ip, url or domain.
$server = server_example; // String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->patchBlwlParam($listType, $serverType, $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 $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $serverType = serverType_example; # String | Server type of the list. Could be one of ip, url or domain.
my $server = server_example; # String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->patchBlwlParam(listType => $listType, serverType => $serverType, 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()
listType = listType_example # String | Type of list, blacklist or whitelist.
serverType = serverType_example # String | Server type of the list. Could be one of ip, url or domain.
server = server_example # String | IP/URL/FQDN depending on the server_type. IPv4 and IPv6 supported.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.patch_blwl_param(listType, serverType, 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
list_type*
String
Type of list, blacklist or whitelist.
Required
server_type*
String
Server type of the list. Could be one of ip, url or domain.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Form parameters
Name Description
server*
String
IP/URL/FQDN depending on the server_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: 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://api.sky.junipersecurity.net/v2/skyatp/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 SkyAtpOpenApi = require('sky_atp_open_api');

var api = new SkyAtpOpenApi.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.


HashLookup

hashLookup

Lookup sample malware score by hash.

Lookup sample malware score by hash (sha256). Optional full scanning report may be requested.


/lookup/hash/{hash_string}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/lookup/hash/{hash_string}?full_report="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashLookupApi;

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

public class HashLookupApiExample {

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

        HashLookupApi apiInstance = new HashLookupApi();
        String hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            ScanResult result = apiInstance.hashLookup(hashString, authorization, fullReport, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashLookupApi#hashLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashLookupApi;

public class HashLookupApiExample {

    public static void main(String[] args) {
        HashLookupApi apiInstance = new HashLookupApi();
        String hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            ScanResult result = apiInstance.hashLookup(hashString, authorization, fullReport, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashLookupApi#hashLookup");
            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 *hashString = hashString_example; // Sample hash. Only SHA256 is supported at this time.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Boolean *fullReport = true; // Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

// Lookup sample malware score by hash.
[apiInstance hashLookupWith:hashString
    authorization:authorization
    fullReport:fullReport
    xForwardedFor:xForwardedFor
              completionHandler: ^(ScanResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.HashLookupApi()

var hashString = hashString_example; // {String} Sample hash. Only SHA256 is supported at this time.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'fullReport': true, // {Boolean} Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class hashLookupExample
    {
        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 HashLookupApi();
            var hashString = hashString_example;  // String | Sample hash. Only SHA256 is supported at this time.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var fullReport = true;  // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                // Lookup sample malware score by hash.
                ScanResult result = apiInstance.hashLookup(hashString, authorization, fullReport, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashLookupApi.hashLookup: " + 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\HashLookupApi();
$hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::HashLookupApi->new();
my $hashString = hashString_example; # String | Sample hash. Only SHA256 is supported at this time.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $fullReport = true; # Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->hashLookup(hashString => $hashString, authorization => $authorization, fullReport => $fullReport, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashLookupApi->hashLookup: $@\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.HashLookupApi()
hashString = hashString_example # String | Sample hash. Only SHA256 is supported at this time.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
fullReport = true # Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    # Lookup sample malware score by hash.
    api_response = api_instance.hash_lookup(hashString, authorization, fullReport=fullReport, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashLookupApi->hashLookup: %s\n" % e)

Parameters

Path parameters
Name Description
hash_string*
String
Sample hash. Only SHA256 is supported at this time.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Query parameters
Name Description
full_report
Boolean
Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

Responses

Status: 200 - Hash lookup succeeded. Returns a result JSON object.

{sha256=516f3396086598142db5e242bc2c8f69f4f5058a637cd2f9bf5dcb4619869536, score=-1, report=null, malware_info={ident=MemScan:Trojan.Pws}, scan_complete=false, last_update=0}

Status: 401 - Invalid API key

Status: 404 - Sample not found.

Status: 422 - Missing or invalid parameters to HTTP call.

Status: 429 - Client has sent too many requests in a given amount of time. Submission 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.


stixLookup

Lookup generated stix data by hash.

Lookup generated stix data by hash (sha256).


/lookup/stix/{hash_string}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/lookup/stix/{hash_string}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HashLookupApi;

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

public class HashLookupApiExample {

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

        HashLookupApi apiInstance = new HashLookupApi();
        String hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            StixResult result = apiInstance.stixLookup(hashString, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashLookupApi#stixLookup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.HashLookupApi;

public class HashLookupApiExample {

    public static void main(String[] args) {
        HashLookupApi apiInstance = new HashLookupApi();
        String hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            StixResult result = apiInstance.stixLookup(hashString, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HashLookupApi#stixLookup");
            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 *hashString = hashString_example; // Sample hash. Only SHA256 is supported at this time.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

// Lookup generated stix data by hash.
[apiInstance stixLookupWith:hashString
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(StixResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.HashLookupApi()

var hashString = hashString_example; // {String} Sample hash. Only SHA256 is supported at this time.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class stixLookupExample
    {
        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 HashLookupApi();
            var hashString = hashString_example;  // String | Sample hash. Only SHA256 is supported at this time.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                // Lookup generated stix data by hash.
                StixResult result = apiInstance.stixLookup(hashString, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HashLookupApi.stixLookup: " + 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\HashLookupApi();
$hashString = hashString_example; // String | Sample hash. Only SHA256 is supported at this time.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::HashLookupApi->new();
my $hashString = hashString_example; # String | Sample hash. Only SHA256 is supported at this time.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->stixLookup(hashString => $hashString, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HashLookupApi->stixLookup: $@\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.HashLookupApi()
hashString = hashString_example # String | Sample hash. Only SHA256 is supported at this time.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    # Lookup generated stix data by hash.
    api_response = api_instance.stix_lookup(hashString, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HashLookupApi->stixLookup: %s\n" % e)

Parameters

Path parameters
Name Description
hash_string*
String
Sample hash. Only SHA256 is supported at this time.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.

Responses

Status: 200 - Hash lookup succeeded. Returns a result STIX XML object.

{data=<xml> Some Content </xml>}

Status: 401 - Invalid API key

Status: 404 - Sample not found.

Status: 422 - Missing or invalid parameters to HTTP call.

Status: 429 - Client has sent too many requests in a given amount of time. Submission 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.


InfectedHostsBlwl

getInfectedHostsBlwl

Returns Infected hosts blacklist/whitelist IPs.


/infected_hosts/{list_type}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/infected_hosts/{list_type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfectedHostsBlwlApi;

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

public class InfectedHostsBlwlApiExample {

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

        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            InfectedHostsBlwlResult result = apiInstance.getInfectedHostsBlwl(listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#getInfectedHostsBlwl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InfectedHostsBlwlApi;

public class InfectedHostsBlwlApiExample {

    public static void main(String[] args) {
        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            InfectedHostsBlwlResult result = apiInstance.getInfectedHostsBlwl(listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#getInfectedHostsBlwl");
            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 *listType = listType_example; // Type of list, blacklist or whitelist.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance getInfectedHostsBlwlWith:listType
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(InfectedHostsBlwlResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.InfectedHostsBlwlApi()

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class getInfectedHostsBlwlExample
    {
        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 InfectedHostsBlwlApi();
            var listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                InfectedHostsBlwlResult result = apiInstance.getInfectedHostsBlwl(listType, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfectedHostsBlwlApi.getInfectedHostsBlwl: " + 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\InfectedHostsBlwlApi();
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::InfectedHostsBlwlApi->new();
my $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->getInfectedHostsBlwl(listType => $listType, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfectedHostsBlwlApi->getInfectedHostsBlwl: $@\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.InfectedHostsBlwlApi()
listType = listType_example # String | Type of list, blacklist or whitelist.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.get_infected_hosts_blwl(listType, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfectedHostsBlwlApi->getInfectedHostsBlwl: %s\n" % e)

Parameters

Path parameters
Name Description
list_type*
String
Type of list, blacklist or whitelist.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.

Responses

Status: 200 - List of infected host entries

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

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.


getInfectedHostsFeed

Returns all Infected hosts feed entries.


/infected_hosts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/infected_hosts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfectedHostsBlwlApi;

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

public class InfectedHostsBlwlApiExample {

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

        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            InfectedHostsBlwlResult result = apiInstance.getInfectedHostsFeed(authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#getInfectedHostsFeed");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InfectedHostsBlwlApi;

public class InfectedHostsBlwlApiExample {

    public static void main(String[] args) {
        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            InfectedHostsBlwlResult result = apiInstance.getInfectedHostsFeed(authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#getInfectedHostsFeed");
            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 *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance getInfectedHostsFeedWith:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(InfectedHostsBlwlResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.InfectedHostsBlwlApi()

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class getInfectedHostsFeedExample
    {
        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 InfectedHostsBlwlApi();
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                InfectedHostsBlwlResult result = apiInstance.getInfectedHostsFeed(authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfectedHostsBlwlApi.getInfectedHostsFeed: " + 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\InfectedHostsBlwlApi();
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::InfectedHostsBlwlApi->new();
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->getInfectedHostsFeed(authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfectedHostsBlwlApi->getInfectedHostsFeed: $@\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.InfectedHostsBlwlApi()
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.get_infected_hosts_feed(authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfectedHostsBlwlApi->getInfectedHostsFeed: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.

Responses

Status: 200 - List of infected host entries

Status: 400 - Request parameters are invalid

Status: 401 - Invalid/Expired API key

Status: 403 - Access denied for this API key

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.


removeInfectedHostsBlwl

Delete IP from a blacklist/whitelist for infected hosts


/infected_hosts/{list_type}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/infected_hosts/{list_type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfectedHostsBlwlApi;

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

public class InfectedHostsBlwlApiExample {

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

        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        Infected_hosts_blwl body = ; // Infected_hosts_blwl |
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.removeInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#removeInfectedHostsBlwl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InfectedHostsBlwlApi;

public class InfectedHostsBlwlApiExample {

    public static void main(String[] args) {
        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        Infected_hosts_blwl body = ; // Infected_hosts_blwl |
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.removeInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#removeInfectedHostsBlwl");
            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"];

Infected_hosts_blwl *body = ; //
String *listType = listType_example; // Type of list, blacklist or whitelist.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance removeInfectedHostsBlwlWith:body
    listType:listType
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.InfectedHostsBlwlApi()

var body = ; // {Infected_hosts_blwl}

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class removeInfectedHostsBlwlExample
    {
        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 InfectedHostsBlwlApi();
            var body = new Infected_hosts_blwl(); // Infected_hosts_blwl |
            var listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.removeInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfectedHostsBlwlApi.removeInfectedHostsBlwl: " + 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\InfectedHostsBlwlApi();
$body = ; // Infected_hosts_blwl |
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::InfectedHostsBlwlApi->new();
my $body = WWW::SwaggerClient::Object::Infected_hosts_blwl->new(); # Infected_hosts_blwl |
my $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->removeInfectedHostsBlwl(body => $body, listType => $listType, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfectedHostsBlwlApi->removeInfectedHostsBlwl: $@\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.InfectedHostsBlwlApi()
body =  # Infected_hosts_blwl |
listType = listType_example # String | Type of list, blacklist or whitelist.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.remove_infected_hosts_blwl(body, listType, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfectedHostsBlwlApi->removeInfectedHostsBlwl: %s\n" % e)

Parameters

Path parameters
Name Description
list_type*
String
Type of list, blacklist or whitelist.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Body parameters
Name Description
body *

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


updateInfectedHostsBlwl

Updates an IP in a blacklist/whitelist for infected hosts


/infected_hosts/{list_type}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/infected_hosts/{list_type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfectedHostsBlwlApi;

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

public class InfectedHostsBlwlApiExample {

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

        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        Infected_hosts_blwl body = ; // Infected_hosts_blwl |
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.updateInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#updateInfectedHostsBlwl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InfectedHostsBlwlApi;

public class InfectedHostsBlwlApiExample {

    public static void main(String[] args) {
        InfectedHostsBlwlApi apiInstance = new InfectedHostsBlwlApi();
        Infected_hosts_blwl body = ; // Infected_hosts_blwl |
        String listType = listType_example; // String | Type of list, blacklist or whitelist.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            Object result = apiInstance.updateInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfectedHostsBlwlApi#updateInfectedHostsBlwl");
            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"];

Infected_hosts_blwl *body = ; //
String *listType = listType_example; // Type of list, blacklist or whitelist.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

[apiInstance updateInfectedHostsBlwlWith:body
    listType:listType
    authorization:authorization
    xForwardedFor:xForwardedFor
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.InfectedHostsBlwlApi()

var body = ; // {Infected_hosts_blwl}

var listType = listType_example; // {String} Type of list, blacklist or whitelist.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

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

namespace Example
{
    public class updateInfectedHostsBlwlExample
    {
        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 InfectedHostsBlwlApi();
            var body = new Infected_hosts_blwl(); // Infected_hosts_blwl |
            var listType = listType_example;  // String | Type of list, blacklist or whitelist.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                Object result = apiInstance.updateInfectedHostsBlwl(body, listType, authorization, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfectedHostsBlwlApi.updateInfectedHostsBlwl: " + 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\InfectedHostsBlwlApi();
$body = ; // Infected_hosts_blwl |
$listType = listType_example; // String | Type of list, blacklist or whitelist.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

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

# 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::InfectedHostsBlwlApi->new();
my $body = WWW::SwaggerClient::Object::Infected_hosts_blwl->new(); # Infected_hosts_blwl |
my $listType = listType_example; # String | Type of list, blacklist or whitelist.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->updateInfectedHostsBlwl(body => $body, listType => $listType, authorization => $authorization, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfectedHostsBlwlApi->updateInfectedHostsBlwl: $@\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.InfectedHostsBlwlApi()
body =  # Infected_hosts_blwl |
listType = listType_example # String | Type of list, blacklist or whitelist.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    api_response = api_instance.update_infected_hosts_blwl(body, listType, authorization, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfectedHostsBlwlApi->updateInfectedHostsBlwl: %s\n" % e)

Parameters

Path parameters
Name Description
list_type*
String
Type of list, blacklist or whitelist.
Required
Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Body parameters
Name Description
body *

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


SubmitSample

submitSample

Submit sample for malware analysis.

Submit sample for malware analysis. To call this method, the user must provide a `file` parameter containing file content to be uploaded. The user also may provide additional information related to the sample such as client/remote IP, sample URL, client host name, name of the user who downloaded the sample, etc. If the submitted sample is determined to be malicious, Sky ATP may use this additional information to track the client within the internal network and notify the user that the host is infected.


/submit/sample

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "http://api.sky.junipersecurity.net/v2/skyatp/submit/sample?full_report="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubmitSampleApi;

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

public class SubmitSampleApiExample {

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

        SubmitSampleApi apiInstance = new SubmitSampleApi();
        File file = /path/to/file.txt; // File | Sample file to submit.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

        String sampleUrl = sampleUrl_example; // String | URL where the sample was downloaded from.
        String remoteIp = remoteIp_example; // String | IP address where the sample was downloaded from.
        String clientIp = clientIp_example; // String | IP address of the client that downloaded this sample.
        String clientHostname = clientHostname_example; // String | Hostname of the client that downloaded this sample.
        String username = username_example; // String | Username of the client that downloaded this sample.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            ScanResult result = apiInstance.submitSample(file, authorization, fullReport, sampleUrl, remoteIp, clientIp, clientHostname, username, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubmitSampleApi#submitSample");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SubmitSampleApi;

public class SubmitSampleApiExample {

    public static void main(String[] args) {
        SubmitSampleApi apiInstance = new SubmitSampleApi();
        File file = /path/to/file.txt; // File | Sample file to submit.
        String authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
        Boolean fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

        String sampleUrl = sampleUrl_example; // String | URL where the sample was downloaded from.
        String remoteIp = remoteIp_example; // String | IP address where the sample was downloaded from.
        String clientIp = clientIp_example; // String | IP address of the client that downloaded this sample.
        String clientHostname = clientHostname_example; // String | Hostname of the client that downloaded this sample.
        String username = username_example; // String | Username of the client that downloaded this sample.
        String xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.
        try {
            ScanResult result = apiInstance.submitSample(file, authorization, fullReport, sampleUrl, remoteIp, clientIp, clientHostname, username, xForwardedFor);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubmitSampleApi#submitSample");
            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"];

File *file = /path/to/file.txt; // Sample file to submit.
String *authorization = authorization_example; // Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Boolean *fullReport = true; // Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
String *sampleUrl = sampleUrl_example; // URL where the sample was downloaded from. (optional)
String *remoteIp = remoteIp_example; // IP address where the sample was downloaded from. (optional)
String *clientIp = clientIp_example; // IP address of the client that downloaded this sample. (optional)
String *clientHostname = clientHostname_example; // Hostname of the client that downloaded this sample. (optional)
String *username = username_example; // Username of the client that downloaded this sample. (optional)
String *xForwardedFor = xForwardedFor_example; // This is a header that provides tracking information for API usage. (optional)

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

// Submit sample for malware analysis.
[apiInstance submitSampleWith:file
    authorization:authorization
    fullReport:fullReport
    sampleUrl:sampleUrl
    remoteIp:remoteIp
    clientIp:clientIp
    clientHostname:clientHostname
    username:username
    xForwardedFor:xForwardedFor
              completionHandler: ^(ScanResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SkyAtpOpenApi = require('sky_atp_open_api');
var defaultClient = SkyAtpOpenApi.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 SkyAtpOpenApi.SubmitSampleApi()

var file = /path/to/file.txt; // {File} Sample file to submit.

var authorization = authorization_example; // {String} Bearer token of the form, Bearer token, token is application token generated from Customer Portal.

var opts = {
  'fullReport': true, // {Boolean} Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

  'sampleUrl': sampleUrl_example, // {String} URL where the sample was downloaded from.
  'remoteIp': remoteIp_example, // {String} IP address where the sample was downloaded from.
  'clientIp': clientIp_example, // {String} IP address of the client that downloaded this sample.
  'clientHostname': clientHostname_example, // {String} Hostname of the client that downloaded this sample.
  'username': username_example, // {String} Username of the client that downloaded this sample.
  'xForwardedFor': xForwardedFor_example // {String} This is a header that provides tracking information for API usage.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.submitSample(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 submitSampleExample
    {
        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 SubmitSampleApi();
            var file = new File(); // File | Sample file to submit.
            var authorization = authorization_example;  // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
            var fullReport = true;  // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
            var sampleUrl = sampleUrl_example;  // String | URL where the sample was downloaded from. (optional)
            var remoteIp = remoteIp_example;  // String | IP address where the sample was downloaded from. (optional)
            var clientIp = clientIp_example;  // String | IP address of the client that downloaded this sample. (optional)
            var clientHostname = clientHostname_example;  // String | Hostname of the client that downloaded this sample. (optional)
            var username = username_example;  // String | Username of the client that downloaded this sample. (optional)
            var xForwardedFor = xForwardedFor_example;  // String | This is a header that provides tracking information for API usage. (optional)

            try
            {
                // Submit sample for malware analysis.
                ScanResult result = apiInstance.submitSample(file, authorization, fullReport, sampleUrl, remoteIp, clientIp, clientHostname, username, xForwardedFor);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubmitSampleApi.submitSample: " + 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\SubmitSampleApi();
$file = /path/to/file.txt; // File | Sample file to submit.
$authorization = authorization_example; // String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
$fullReport = true; // Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

$sampleUrl = sampleUrl_example; // String | URL where the sample was downloaded from.
$remoteIp = remoteIp_example; // String | IP address where the sample was downloaded from.
$clientIp = clientIp_example; // String | IP address of the client that downloaded this sample.
$clientHostname = clientHostname_example; // String | Hostname of the client that downloaded this sample.
$username = username_example; // String | Username of the client that downloaded this sample.
$xForwardedFor = xForwardedFor_example; // String | This is a header that provides tracking information for API usage.

try {
    $result = $api_instance->submitSample($file, $authorization, $fullReport, $sampleUrl, $remoteIp, $clientIp, $clientHostname, $username, $xForwardedFor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubmitSampleApi->submitSample: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubmitSampleApi;

# 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::SubmitSampleApi->new();
my $file = /path/to/file.txt; # File | Sample file to submit.
my $authorization = authorization_example; # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
my $fullReport = true; # Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

my $sampleUrl = sampleUrl_example; # String | URL where the sample was downloaded from.
my $remoteIp = remoteIp_example; # String | IP address where the sample was downloaded from.
my $clientIp = clientIp_example; # String | IP address of the client that downloaded this sample.
my $clientHostname = clientHostname_example; # String | Hostname of the client that downloaded this sample.
my $username = username_example; # String | Username of the client that downloaded this sample.
my $xForwardedFor = xForwardedFor_example; # String | This is a header that provides tracking information for API usage.

eval {
    my $result = $api_instance->submitSample(file => $file, authorization => $authorization, fullReport => $fullReport, sampleUrl => $sampleUrl, remoteIp => $remoteIp, clientIp => $clientIp, clientHostname => $clientHostname, username => $username, xForwardedFor => $xForwardedFor);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubmitSampleApi->submitSample: $@\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.SubmitSampleApi()
file = /path/to/file.txt # File | Sample file to submit.
authorization = authorization_example # String | Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
fullReport = true # Boolean | Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.
 (optional)
sampleUrl = sampleUrl_example # String | URL where the sample was downloaded from. (optional)
remoteIp = remoteIp_example # String | IP address where the sample was downloaded from. (optional)
clientIp = clientIp_example # String | IP address of the client that downloaded this sample. (optional)
clientHostname = clientHostname_example # String | Hostname of the client that downloaded this sample. (optional)
username = username_example # String | Username of the client that downloaded this sample. (optional)
xForwardedFor = xForwardedFor_example # String | This is a header that provides tracking information for API usage. (optional)

try:
    # Submit sample for malware analysis.
    api_response = api_instance.submit_sample(file, authorization, fullReport=fullReport, sampleUrl=sampleUrl, remoteIp=remoteIp, clientIp=clientIp, clientHostname=clientHostname, username=username, xForwardedFor=xForwardedFor)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubmitSampleApi->submitSample: %s\n" % e)

Parameters

Header parameters
Name Description
Authorization*
String
Bearer token of the form, Bearer token, token is application token generated from Customer Portal.
Required
X-Forwarded-For
String
This is a header that provides tracking information for API usage.
Form parameters
Name Description
file*
File
Sample file to submit.
Required
sample_url
String
URL where the sample was downloaded from.
remote_ip
String
IP address where the sample was downloaded from.
client_ip
String
IP address of the client that downloaded this sample.
client_hostname
String
Hostname of the client that downloaded this sample.
username
String
Username of the client that downloaded this sample.
Query parameters
Name Description
full_report
Boolean
Whether to return a full scanning report. This should be set to true if user wants to retrieve a detailed sample analysis report in JSON format.

Responses

Status: 200 - File submission succeeded. Returns a submission JSON object.

{sha256=516f3396086598142db5e242bc2c8f69f4f5058a637cd2f9bf5dcb4619869536, score=10, malware_info={ident=MemScan:Trojan.Pws}, scan_complete=true, last_update=1464891625}

Status: 401 - Invalid API key.

Status: 413 - Sample file size over max limit.

Status: 422 - Missing or invalid parameters to HTTP call.

Status: 429 - Client has sent too many requests in a given amount of time. Submission 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.