Scarlet Shark API

Default

get_service_ips

Returns service IP addresses and networks.

Returns a list of known IPs and networks used by the service specified by the service_id or service_name parameter.


/get_service_ips

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/get_service_ips?service_name=&service_id=&limit=&max_age=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String serviceName = serviceName_example; // String | The service name of the service to retrun IPs for.
        Integer serviceId = 56; // Integer | The service_id of the service to retrun IPs for.
        Integer limit = 56; // Integer | The number of results to return.
        Integer maxAge = 56; // Integer | The max age, in days, for the last time this service was identified using this IP.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200 result = apiInstance.get_service_ips(serviceName, serviceId, limit, maxAge, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_service_ips");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String serviceName = serviceName_example; // String | The service name of the service to retrun IPs for.
        Integer serviceId = 56; // Integer | The service_id of the service to retrun IPs for.
        Integer limit = 56; // Integer | The number of results to return.
        Integer maxAge = 56; // Integer | The max age, in days, for the last time this service was identified using this IP.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200 result = apiInstance.get_service_ips(serviceName, serviceId, limit, maxAge, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_service_ips");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *serviceName = serviceName_example; // The service name of the service to retrun IPs for. (optional)
Integer *serviceId = 56; // The service_id of the service to retrun IPs for. (optional)
Integer *limit = 56; // The number of results to return. (optional) (default to 5000)
Integer *maxAge = 56; // The max age, in days, for the last time this service was identified using this IP. (optional) (default to 90)
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns service IP addresses and networks.
[apiInstance get_service_ipsWith:serviceName
    serviceId:serviceId
    limit:limit
    maxAge:maxAge
    nonce:nonce
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var opts = {
  'serviceName': serviceName_example, // {{String}} The service name of the service to retrun IPs for.
  'serviceId': 56, // {{Integer}} The service_id of the service to retrun IPs for.
  'limit': 56, // {{Integer}} The number of results to return.
  'maxAge': 56, // {{Integer}} The max age, in days, for the last time this service was identified using this IP.
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_service_ips(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var serviceName = serviceName_example;  // String | The service name of the service to retrun IPs for. (optional)
            var serviceId = 56;  // Integer | The service_id of the service to retrun IPs for. (optional)
            var limit = 56;  // Integer | The number of results to return. (optional)  (default to 5000)
            var maxAge = 56;  // Integer | The max age, in days, for the last time this service was identified using this IP. (optional)  (default to 90)
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns service IP addresses and networks.
                inline_response_200 result = apiInstance.get_service_ips(serviceName, serviceId, limit, maxAge, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.get_service_ips: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$serviceName = serviceName_example; // String | The service name of the service to retrun IPs for.
$serviceId = 56; // Integer | The service_id of the service to retrun IPs for.
$limit = 56; // Integer | The number of results to return.
$maxAge = 56; // Integer | The max age, in days, for the last time this service was identified using this IP.
$nonce = 56; // Integer | A request nonce.

try {
    $result = $api_instance->get_service_ips($serviceName, $serviceId, $limit, $maxAge, $nonce);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->get_service_ips: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $serviceName = serviceName_example; # String | The service name of the service to retrun IPs for.
my $serviceId = 56; # Integer | The service_id of the service to retrun IPs for.
my $limit = 56; # Integer | The number of results to return.
my $maxAge = 56; # Integer | The max age, in days, for the last time this service was identified using this IP.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->get_service_ips(serviceName => $serviceName, serviceId => $serviceId, limit => $limit, maxAge => $maxAge, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->get_service_ips: $@\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()
serviceName = serviceName_example # String | The service name of the service to retrun IPs for. (optional)
serviceId = 56 # Integer | The service_id of the service to retrun IPs for. (optional)
limit = 56 # Integer | The number of results to return. (optional) (default to 5000)
maxAge = 56 # Integer | The max age, in days, for the last time this service was identified using this IP. (optional) (default to 90)
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns service IP addresses and networks.
    api_response = api_instance.get_service_ips(serviceName=serviceName, serviceId=serviceId, limit=limit, maxAge=maxAge, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_service_ips: %s\n" % e)

Parameters

Query parameters
Name Description
service_name
String
The service name of the service to retrun IPs for.
service_id
Integer
The service_id of the service to retrun IPs for.
limit
Integer
The number of results to return.
max_age
Integer
The max age, in days, for the last time this service was identified using this IP.
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 406 - No Service Identification Provided.

Status: 500 - Internal Server Error


get_threat_actor_details

Returns detailed information about a given threat actor.

Returns detailed information about a given threat actor.


/get_threat_actor_details

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/get_threat_actor_details?threat_actor_name=&threat_actor_id=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String threatActorName = threatActorName_example; // String | A name or alias of a threat actor.
        Integer threatActorId = 56; // Integer | The Scarlet Shark threat_actor_id to search by.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_1 result = apiInstance.get_threat_actor_details(threatActorName, threatActorId, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_threat_actor_details");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String threatActorName = threatActorName_example; // String | A name or alias of a threat actor.
        Integer threatActorId = 56; // Integer | The Scarlet Shark threat_actor_id to search by.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_1 result = apiInstance.get_threat_actor_details(threatActorName, threatActorId, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_threat_actor_details");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *threatActorName = threatActorName_example; // A name or alias of a threat actor. (optional)
Integer *threatActorId = 56; // The Scarlet Shark threat_actor_id to search by. (optional)
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns detailed information about a given threat actor.
[apiInstance get_threat_actor_detailsWith:threatActorName
    threatActorId:threatActorId
    nonce:nonce
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var opts = {
  'threatActorName': threatActorName_example, // {{String}} A name or alias of a threat actor.
  'threatActorId': 56, // {{Integer}} The Scarlet Shark threat_actor_id to search by.
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_threat_actor_details(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var threatActorName = threatActorName_example;  // String | A name or alias of a threat actor. (optional)
            var threatActorId = 56;  // Integer | The Scarlet Shark threat_actor_id to search by. (optional)
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns detailed information about a given threat actor.
                inline_response_200_1 result = apiInstance.get_threat_actor_details(threatActorName, threatActorId, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.get_threat_actor_details: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$threatActorName = threatActorName_example; // String | A name or alias of a threat actor.
$threatActorId = 56; // Integer | The Scarlet Shark threat_actor_id to search by.
$nonce = 56; // Integer | A request nonce.

try {
    $result = $api_instance->get_threat_actor_details($threatActorName, $threatActorId, $nonce);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->get_threat_actor_details: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $threatActorName = threatActorName_example; # String | A name or alias of a threat actor.
my $threatActorId = 56; # Integer | The Scarlet Shark threat_actor_id to search by.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->get_threat_actor_details(threatActorName => $threatActorName, threatActorId => $threatActorId, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->get_threat_actor_details: $@\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()
threatActorName = threatActorName_example # String | A name or alias of a threat actor. (optional)
threatActorId = 56 # Integer | The Scarlet Shark threat_actor_id to search by. (optional)
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns detailed information about a given threat actor.
    api_response = api_instance.get_threat_actor_details(threatActorName=threatActorName, threatActorId=threatActorId, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_threat_actor_details: %s\n" % e)

Parameters

Query parameters
Name Description
threat_actor_name
String
A name or alias of a threat actor.
threat_actor_id
Integer
The Scarlet Shark threat_actor_id to search by.
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


get_threat_tool_details

Returns detailed information about a given threat tool.

Returns detailed information about a given threat tool. The threat tool can be malware or a legitimate tool.


/get_threat_tool_details

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/get_threat_tool_details?threat_tool_name=&threat_actor_id=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String threatToolName = threatToolName_example; // String | A name or alias of a threat tool.
        Integer threatActorId = 56; // Integer | The Scarlet Shark threat_tool_id to search by.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_2 result = apiInstance.get_threat_tool_details(threatToolName, threatActorId, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_threat_tool_details");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String threatToolName = threatToolName_example; // String | A name or alias of a threat tool.
        Integer threatActorId = 56; // Integer | The Scarlet Shark threat_tool_id to search by.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_2 result = apiInstance.get_threat_tool_details(threatToolName, threatActorId, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#get_threat_tool_details");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *threatToolName = threatToolName_example; // A name or alias of a threat tool. (optional)
Integer *threatActorId = 56; // The Scarlet Shark threat_tool_id to search by. (optional)
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns detailed information about a given threat tool.
[apiInstance get_threat_tool_detailsWith:threatToolName
    threatActorId:threatActorId
    nonce:nonce
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var opts = {
  'threatToolName': threatToolName_example, // {{String}} A name or alias of a threat tool.
  'threatActorId': 56, // {{Integer}} The Scarlet Shark threat_tool_id to search by.
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.get_threat_tool_details(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var threatToolName = threatToolName_example;  // String | A name or alias of a threat tool. (optional)
            var threatActorId = 56;  // Integer | The Scarlet Shark threat_tool_id to search by. (optional)
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns detailed information about a given threat tool.
                inline_response_200_2 result = apiInstance.get_threat_tool_details(threatToolName, threatActorId, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.get_threat_tool_details: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$threatToolName = threatToolName_example; // String | A name or alias of a threat tool.
$threatActorId = 56; // Integer | The Scarlet Shark threat_tool_id to search by.
$nonce = 56; // Integer | A request nonce.

try {
    $result = $api_instance->get_threat_tool_details($threatToolName, $threatActorId, $nonce);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->get_threat_tool_details: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $threatToolName = threatToolName_example; # String | A name or alias of a threat tool.
my $threatActorId = 56; # Integer | The Scarlet Shark threat_tool_id to search by.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->get_threat_tool_details(threatToolName => $threatToolName, threatActorId => $threatActorId, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->get_threat_tool_details: $@\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()
threatToolName = threatToolName_example # String | A name or alias of a threat tool. (optional)
threatActorId = 56 # Integer | The Scarlet Shark threat_tool_id to search by. (optional)
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns detailed information about a given threat tool.
    api_response = api_instance.get_threat_tool_details(threatToolName=threatToolName, threatActorId=threatActorId, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->get_threat_tool_details: %s\n" % e)

Parameters

Query parameters
Name Description
threat_tool_name
String
A name or alias of a threat tool.
threat_actor_id
Integer
The Scarlet Shark threat_tool_id to search by.
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 406 - Not Acceptable

Status: 500 - Internal Server Error


search_dns

Returns known hostname and IP resolutions.

Returns known hostname and IP resolutions. These associations are mostly active IP lookups.


/search_dns

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_dns?ip=&hostname=&max_age=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | An IPv4 or IPv6 address to find hostnames for.
        String hostname = hostname_example; // String | A hostname to find IPs for.
        Integer maxAge = 56; // Integer | The maximum number of days since an entry was last seen.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_3 result = apiInstance.search_dns(ip, hostname, maxAge, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_dns");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | An IPv4 or IPv6 address to find hostnames for.
        String hostname = hostname_example; // String | A hostname to find IPs for.
        Integer maxAge = 56; // Integer | The maximum number of days since an entry was last seen.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_3 result = apiInstance.search_dns(ip, hostname, maxAge, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_dns");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *ip = ip_example; // An IPv4 or IPv6 address to find hostnames for. (optional)
String *hostname = hostname_example; // A hostname to find IPs for. (optional)
Integer *maxAge = 56; // The maximum number of days since an entry was last seen. (optional)
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns known hostname and IP resolutions.
[apiInstance search_dnsWith:ip
    hostname:hostname
    maxAge:maxAge
    nonce:nonce
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var opts = {
  'ip': ip_example, // {{String}} An IPv4 or IPv6 address to find hostnames for.
  'hostname': hostname_example, // {{String}} A hostname to find IPs for.
  'maxAge': 56, // {{Integer}} The maximum number of days since an entry was last seen.
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_dns(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var ip = ip_example;  // String | An IPv4 or IPv6 address to find hostnames for. (optional)
            var hostname = hostname_example;  // String | A hostname to find IPs for. (optional)
            var maxAge = 56;  // Integer | The maximum number of days since an entry was last seen. (optional)
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns known hostname and IP resolutions.
                inline_response_200_3 result = apiInstance.search_dns(ip, hostname, maxAge, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_dns: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$ip = ip_example; // String | An IPv4 or IPv6 address to find hostnames for.
$hostname = hostname_example; // String | A hostname to find IPs for.
$maxAge = 56; // Integer | The maximum number of days since an entry was last seen.
$nonce = 56; // Integer | A request nonce.

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


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $ip = ip_example; # String | An IPv4 or IPv6 address to find hostnames for.
my $hostname = hostname_example; # String | A hostname to find IPs for.
my $maxAge = 56; # Integer | The maximum number of days since an entry was last seen.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_dns(ip => $ip, hostname => $hostname, maxAge => $maxAge, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_dns: $@\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()
ip = ip_example # String | An IPv4 or IPv6 address to find hostnames for. (optional)
hostname = hostname_example # String | A hostname to find IPs for. (optional)
maxAge = 56 # Integer | The maximum number of days since an entry was last seen. (optional)
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns known hostname and IP resolutions.
    api_response = api_instance.search_dns(ip=ip, hostname=hostname, maxAge=maxAge, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_dns: %s\n" % e)

Parameters

Query parameters
Name Description
ip
String
An IPv4 or IPv6 address to find hostnames for.
hostname
String
A hostname to find IPs for.
max_age
Integer
The maximum number of days since an entry was last seen.
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


search_domain

Returns information on the given domain.

Returns information on the given domain.


/search_domain

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_domain?domain=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String domain = domain_example; // String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_4 result = apiInstance.search_domain(domain, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_domain");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String domain = domain_example; // String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_4 result = apiInstance.search_domain(domain, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_domain");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *domain = domain_example; // The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns information on the given domain.
[apiInstance search_domainWith:domain
    nonce:nonce
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var domain = domain_example; // {{String}} The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
var opts = {
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_domain(domain, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var domain = domain_example;  // String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns information on the given domain.
                inline_response_200_4 result = apiInstance.search_domain(domain, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_domain: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$domain = domain_example; // String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
$nonce = 56; // Integer | A request nonce.

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


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $domain = domain_example; # String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_domain(domain => $domain, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_domain: $@\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()
domain = domain_example # String | The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns information on the given domain.
    api_response = api_instance.search_domain(domain, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_domain: %s\n" % e)

Parameters

Query parameters
Name Description
domain*
String
The domain to search for. The domain will automatically be changed from Unicode to an IDNA ASCII-compatible format.
Required
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


search_email

Returns threat information for the given email addresses.

Returns threat information for the given email addresses.


/search_email

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_email?emails[]=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        array[String] emails[] = ; // array[String] | Email addresses to search for threat data on.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_5 result = apiInstance.search_email(emails[], nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_email");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[String] emails[] = ; // array[String] | Email addresses to search for threat data on.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_5 result = apiInstance.search_email(emails[], nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_email");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
array[String] *emails[] = ; // Email addresses to search for threat data on.
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns threat information for the given email addresses.
[apiInstance search_emailWith:emails[]
    nonce:nonce
              completionHandler: ^(inline_response_200_5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var emails[] = ; // {{array[String]}} Email addresses to search for threat data on.
var opts = {
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_email(emails[], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var emails[] = new array[String](); // array[String] | Email addresses to search for threat data on.
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns threat information for the given email addresses.
                inline_response_200_5 result = apiInstance.search_email(emails[], nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_email: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$emails[] = ; // array[String] | Email addresses to search for threat data on.
$nonce = 56; // Integer | A request nonce.

try {
    $result = $api_instance->search_email($emails[], $nonce);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->search_email: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $emails[] = []; # array[String] | Email addresses to search for threat data on.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_email(emails[] => $emails[], nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_email: $@\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()
emails[] =  # array[String] | Email addresses to search for threat data on.
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns threat information for the given email addresses.
    api_response = api_instance.search_email(emails[], nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_email: %s\n" % e)

Parameters

Query parameters
Name Description
emails[]*
array[String]
Email addresses to search for threat data on.
Required
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 406 - No Email Address Provided.

Status: 500 - Internal Server Error


search_hash

Returns information on either a SHA256 or a MD5 file hash.

Returns information on either a SHA256 or a MD5 file hash.


/search_hash

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_hash?sha256=&md5=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String sha256 = sha256_example; // String | A SHA256 file hash to search for.
        String md5 = md5_example; // String | An MD5 file hash to search for.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_6 result = apiInstance.search_hash(sha256, md5, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_hash");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String sha256 = sha256_example; // String | A SHA256 file hash to search for.
        String md5 = md5_example; // String | An MD5 file hash to search for.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_6 result = apiInstance.search_hash(sha256, md5, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_hash");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *sha256 = sha256_example; // A SHA256 file hash to search for. (optional)
String *md5 = md5_example; // An MD5 file hash to search for. (optional)
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns information on either a SHA256 or a MD5 file hash.
[apiInstance search_hashWith:sha256
    md5:md5
    nonce:nonce
              completionHandler: ^(inline_response_200_6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var opts = {
  'sha256': sha256_example, // {{String}} A SHA256 file hash to search for.
  'md5': md5_example, // {{String}} An MD5 file hash to search for.
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_hash(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var sha256 = sha256_example;  // String | A SHA256 file hash to search for. (optional)
            var md5 = md5_example;  // String | An MD5 file hash to search for. (optional)
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns information on either a SHA256 or a MD5 file hash.
                inline_response_200_6 result = apiInstance.search_hash(sha256, md5, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_hash: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$sha256 = sha256_example; // String | A SHA256 file hash to search for.
$md5 = md5_example; // String | An MD5 file hash to search for.
$nonce = 56; // Integer | A request nonce.

try {
    $result = $api_instance->search_hash($sha256, $md5, $nonce);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->search_hash: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $sha256 = sha256_example; # String | A SHA256 file hash to search for.
my $md5 = md5_example; # String | An MD5 file hash to search for.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_hash(sha256 => $sha256, md5 => $md5, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_hash: $@\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()
sha256 = sha256_example # String | A SHA256 file hash to search for. (optional)
md5 = md5_example # String | An MD5 file hash to search for. (optional)
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns information on either a SHA256 or a MD5 file hash.
    api_response = api_instance.search_hash(sha256=sha256, md5=md5, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_hash: %s\n" % e)

Parameters

Query parameters
Name Description
sha256
String
A SHA256 file hash to search for.
md5
String
An MD5 file hash to search for.
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


search_ip

Returns IP addresses information.

Performs a lookup for an IP address and returns geolocation, threat information, service associations, DNS resolutions, and open ports for that IP.


/search_ip

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_ip?ips[]=&nonce=&context=&time_period=&time_zone=&report_timestamps="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        array[String] ips[] = ; // array[String] | An array of Ipv4 or IPv6 address.
        Integer nonce = 56; // Integer | A request nonce.
        String context = context_example; // String | The context of the IP look up. This helps give a more accurate threat classification.
        Integer timePeriod = 56; // Integer | The number of days to show security issues for.
        String timeZone = timeZone_example; // String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
        Boolean reportTimestamps = true; // Boolean | Indicates if an array of all reported timestamps should be returned. Default is false.
        try {
            inline_response_200_7 result = apiInstance.search_ip(ips[], nonce, context, timePeriod, timeZone, reportTimestamps);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_ip");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[String] ips[] = ; // array[String] | An array of Ipv4 or IPv6 address.
        Integer nonce = 56; // Integer | A request nonce.
        String context = context_example; // String | The context of the IP look up. This helps give a more accurate threat classification.
        Integer timePeriod = 56; // Integer | The number of days to show security issues for.
        String timeZone = timeZone_example; // String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
        Boolean reportTimestamps = true; // Boolean | Indicates if an array of all reported timestamps should be returned. Default is false.
        try {
            inline_response_200_7 result = apiInstance.search_ip(ips[], nonce, context, timePeriod, timeZone, reportTimestamps);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_ip");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
array[String] *ips[] = ; // An array of Ipv4 or IPv6 address.
Integer *nonce = 56; // A request nonce. (optional)
String *context = context_example; // The context of the IP look up. This helps give a more accurate threat classification. (optional) (default to none)
Integer *timePeriod = 56; // The number of days to show security issues for. (optional)
String *timeZone = timeZone_example; // A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones. (optional)
Boolean *reportTimestamps = true; // Indicates if an array of all reported timestamps should be returned. Default is false. (optional) (default to false)

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

// Returns IP addresses information.
[apiInstance search_ipWith:ips[]
    nonce:nonce
    context:context
    timePeriod:timePeriod
    timeZone:timeZone
    reportTimestamps:reportTimestamps
              completionHandler: ^(inline_response_200_7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var ips[] = ; // {{array[String]}} An array of Ipv4 or IPv6 address.
var opts = {
  'nonce': 56, // {{Integer}} A request nonce.
  'context': context_example, // {{String}} The context of the IP look up. This helps give a more accurate threat classification.
  'timePeriod': 56, // {{Integer}} The number of days to show security issues for.
  'timeZone': timeZone_example, // {{String}} A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
  'reportTimestamps': true // {{Boolean}} Indicates if an array of all reported timestamps should be returned. Default is false.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_ip(ips[], opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var ips[] = new array[String](); // array[String] | An array of Ipv4 or IPv6 address.
            var nonce = 56;  // Integer | A request nonce. (optional)
            var context = context_example;  // String | The context of the IP look up. This helps give a more accurate threat classification. (optional)  (default to none)
            var timePeriod = 56;  // Integer | The number of days to show security issues for. (optional)
            var timeZone = timeZone_example;  // String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones. (optional)
            var reportTimestamps = true;  // Boolean | Indicates if an array of all reported timestamps should be returned. Default is false. (optional)  (default to false)

            try
            {
                // Returns IP addresses information.
                inline_response_200_7 result = apiInstance.search_ip(ips[], nonce, context, timePeriod, timeZone, reportTimestamps);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_ip: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$ips[] = ; // array[String] | An array of Ipv4 or IPv6 address.
$nonce = 56; // Integer | A request nonce.
$context = context_example; // String | The context of the IP look up. This helps give a more accurate threat classification.
$timePeriod = 56; // Integer | The number of days to show security issues for.
$timeZone = timeZone_example; // String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
$reportTimestamps = true; // Boolean | Indicates if an array of all reported timestamps should be returned. Default is false.

try {
    $result = $api_instance->search_ip($ips[], $nonce, $context, $timePeriod, $timeZone, $reportTimestamps);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->search_ip: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DefaultApi;


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $ips[] = []; # array[String] | An array of Ipv4 or IPv6 address.
my $nonce = 56; # Integer | A request nonce.
my $context = context_example; # String | The context of the IP look up. This helps give a more accurate threat classification.
my $timePeriod = 56; # Integer | The number of days to show security issues for.
my $timeZone = timeZone_example; # String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
my $reportTimestamps = true; # Boolean | Indicates if an array of all reported timestamps should be returned. Default is false.

eval {
    my $result = $api_instance->search_ip(ips[] => $ips[], nonce => $nonce, context => $context, timePeriod => $timePeriod, timeZone => $timeZone, reportTimestamps => $reportTimestamps);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_ip: $@\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()
ips[] =  # array[String] | An array of Ipv4 or IPv6 address.
nonce = 56 # Integer | A request nonce. (optional)
context = context_example # String | The context of the IP look up. This helps give a more accurate threat classification. (optional) (default to none)
timePeriod = 56 # Integer | The number of days to show security issues for. (optional)
timeZone = timeZone_example # String | A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones. (optional)
reportTimestamps = true # Boolean | Indicates if an array of all reported timestamps should be returned. Default is false. (optional) (default to false)

try:
    # Returns IP addresses information.
    api_response = api_instance.search_ip(ips[], nonce=nonce, context=context, timePeriod=timePeriod, timeZone=timeZone, reportTimestamps=reportTimestamps)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_ip: %s\n" % e)

Parameters

Query parameters
Name Description
ips[]*
array[String]
An array of Ipv4 or IPv6 address.
Required
nonce
Integer
A request nonce.
context
String
The context of the IP look up. This helps give a more accurate threat classification.
time_period
Integer
The number of days to show security issues for.
time_zone
String
A PHP Time Zone String. Results will be returned in the given time zoone. UTC is the default. See https://www.php.net/manual/en/timezones.php for a list of valid timezones.
report_timestamps
Boolean
Indicates if an array of all reported timestamps should be returned. Default is false.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


search_network

Returns network information that a given IP is a part of.

Returns network information that a given IP is a part of.


/search_network

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_network?ip=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | An Ipv4 or IPv6 address.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_8 result = apiInstance.search_network(ip, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_network");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String ip = ip_example; // String | An Ipv4 or IPv6 address.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_8 result = apiInstance.search_network(ip, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_network");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
String *ip = ip_example; // An Ipv4 or IPv6 address.
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns network information that a given IP is a part of.
[apiInstance search_networkWith:ip
    nonce:nonce
              completionHandler: ^(inline_response_200_8 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var ip = ip_example; // {{String}} An Ipv4 or IPv6 address.
var opts = {
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_network(ip, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var ip = ip_example;  // String | An Ipv4 or IPv6 address.
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns network information that a given IP is a part of.
                inline_response_200_8 result = apiInstance.search_network(ip, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_network: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$ip = ip_example; // String | An Ipv4 or IPv6 address.
$nonce = 56; // Integer | A request nonce.

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


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $ip = ip_example; # String | An Ipv4 or IPv6 address.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_network(ip => $ip, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_network: $@\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()
ip = ip_example # String | An Ipv4 or IPv6 address.
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns network information that a given IP is a part of.
    api_response = api_instance.search_network(ip, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_network: %s\n" % e)

Parameters

Query parameters
Name Description
ip*
String
An Ipv4 or IPv6 address.
Required
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 404 - Not Found

Status: 405 - Method Not Allowed

Status: 500 - Internal Server Error


search_url

Returns information on the given URLs.

Returns information on the given URLs.


/search_url

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json:"\
"https://api.scarletshark.com/v1.0/search_url?urls=&nonce="
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) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DefaultApi apiInstance = new DefaultApi();
        array[String] urls = ; // array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_9 result = apiInstance.search_url(urls, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_url");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        array[String] urls = ; // array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
        Integer nonce = 56; // Integer | A request nonce.
        try {
            inline_response_200_9 result = apiInstance.search_url(urls, nonce);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#search_url");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
array[String] *urls = ; // An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
Integer *nonce = 56; // A request nonce. (optional)

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

// Returns information on the given URLs.
[apiInstance search_urlWith:urls
    nonce:nonce
              completionHandler: ^(inline_response_200_9 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var ScarletSharkApi = require('scarlet_shark_api');
var defaultClient = ScarletSharkApi.ApiClient.instance;


var api = new ScarletSharkApi.DefaultApi()
var urls = ; // {{array[String]}} An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
var opts = {
  'nonce': 56 // {{Integer}} A request nonce.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.search_url(urls, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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


            var apiInstance = new DefaultApi();
            var urls = new array[String](); // array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
            var nonce = 56;  // Integer | A request nonce. (optional)

            try
            {
                // Returns information on the given URLs.
                inline_response_200_9 result = apiInstance.search_url(urls, nonce);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.search_url: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDefaultApi();
$urls = ; // array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
$nonce = 56; // Integer | A request nonce.

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


my $api_instance = WWW::SwaggerClient::DefaultApi->new();
my $urls = []; # array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
my $nonce = 56; # Integer | A request nonce.

eval {
    my $result = $api_instance->search_url(urls => $urls, nonce => $nonce);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->search_url: $@\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()
urls =  # array[String] | An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
nonce = 56 # Integer | A request nonce. (optional)

try:
    # Returns information on the given URLs.
    api_response = api_instance.search_url(urls, nonce=nonce)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->search_url: %s\n" % e)

Parameters

Query parameters
Name Description
urls*
array[String]
An array of URLs to search for threat data on. The domain of each URL will automatically be changed from Unicode to an IDNA ASCII-compatible format.
Required
nonce
Integer
A request nonce.

Responses

Status: 200 - Successful response

Status: 401 - Unauthorized

Status: 405 - Method Not Allowed

Status: 406 - No URL Provided.

Status: 500 - Internal Server Error