Sandfly Security

Sandfly Security Documentation

Welcome to the Sandfly Security documentation hub. Sandfly is an agentless compromise and intrusion detection system for Linux.

Sandfly automates security investigation and forensic evidence collection on Linux. Sandfly constantly searches for intruders 24 hours a day on your network without needing to load any agents on your endpoints.

Get Started
Suggest Edits

Credentials

 
Suggest Edits

Adds remote system login credentials.

Creates either an sshkey/sshkey password or username/password to an encrypted remote host credential record.

 
posthttps://localhost/v1/credentials/credentials_id
curl --request POST \
  --url https://localhost/v1/credentials/credentials_id
var request = require("request");

var options = { method: 'POST',
  url:
   'https://localhost/v1/credentials/credentials_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/credentials/credentials_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/credentials/credentials_id");

xhr.send(data);
import requests

url = "https://localhost/v1/credentials/credentials_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

credentials_id
string
required

credentials_id to create.

Body Params

ssh_key_b64
string

The ssh_key we can use to login that is base 64 encoded.

ssh_key_password
string

This is the password used to decrypt the ssh_key if we have one.

username
string

This is the username we can use to login.

password
string

This is the password we can use to login if using username credentials.

Response

Remote credentials encrypted and inserted.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Remote credentials already exist. Not overwritten.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets encrypted credentials to allow remote system login.

Gets encrypted credentials to allow scanning nodes to login to a remote host.

 
gethttps://localhost/v1/credentials/credentials_id
curl --request GET \
  --url https://localhost/v1/credentials/credentials_id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/credentials/credentials_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/credentials/credentials_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/credentials/credentials_id");

xhr.send(data);
import requests

url = "https://localhost/v1/credentials/credentials_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

credentials_id
string
required

credentials_id to retrieve.

Response

Credentials retrieved

credentials_idstring

The ID we'll use for this encrypted credential

credentials_typestring

The type of credential that is encrypted username or ssh_key

credentials_datastring

Encrypted credentials in base64 format for use by scanning nodes to authenticate to target.

Credentials not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Updates remote system login credentials.

Updates sshkey/sshkey password or username/password to an encrypted remote host credential record.

 
puthttps://localhost/v1/credentials/credentials_id
curl --request PUT \
  --url https://localhost/v1/credentials/credentials_id
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/credentials/credentials_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/credentials/credentials_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/credentials/credentials_id");

xhr.send(data);
import requests

url = "https://localhost/v1/credentials/credentials_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

credentials_id
string
required

credentials_id to update.

Body Params

ssh_key_b64
string

The ssh_key we can use to login that is base 64 encoded.

ssh_key_password
string

This is the password used to decrypt the ssh_key if we have one.

username
string

This is the username we can use to login.

password
string

This is the password we can use to login if using username credentials.

Response

Remote credentials updated, encrypted, and inserted.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Remote credentials already exist. Not overwritten.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes remote system login encrypted record.

Deletes a remote system login credential encrypted record.

 
deletehttps://localhost/v1/credentials/credentials_id
curl --request DELETE \
  --url https://localhost/v1/credentials/credentials_id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/credentials/credentials_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/credentials/credentials_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/credentials/credentials_id");

xhr.send(data);
import requests

url = "https://localhost/v1/credentials/credentials_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

credentials_id
string
required

credentials_id to delete.

Response

Node credentials deleted

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with delete request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Nothing to delete.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all credentials entered in the system.

Gets all credentials entered in the system.

 
gethttps://localhost/v1/credentials
curl --request GET \
  --url https://localhost/v1/credentials
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/credentials' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/credentials");

xhr.send(data);
import requests

url = "https://localhost/v1/credentials"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Credentials retrieved

credentials_idstring

The ID we'll use for this encrypted credential

credentials_typestring

The type of credential that is encrypted username or ssh_key

credentials_datastring

Encrypted credentials in base64 format for use by scanning nodes to authenticate to target.

Credentials not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets a registered host

This gets a registered host by host_id.

 
gethttps://localhost/v1/hosts/host_id
curl --request GET \
  --url https://localhost/v1/hosts/host_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/hosts/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/hosts/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/host_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to retrieve.

Response

Host information retrieved

activeboolean

Is this host active (valid credentials and login)?

authentication_statusstring

What is the state of the authentication? ok, failed, error

dataobject

Raw data of system information collected.

date_first_seenstring

Date first saw this host.

date_last_seenstring

Last time we saw this host.

first_seen_ip_addrstring

First IP address we saw for this host.

last_seen_ip_addrstring

Last IP address we saw for this host.

host_aliasstring

A host alias which can be assigned by the GUI.

tagsarray

A list of tags for this host.

host_idstring

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_namestring

The hostname or IP of the host.

os_systemstring

Generic OS name

os_releasestring

Remote kernel/os version we saw.

os_machinestring

Other machine hardware identifier.

os_versionstring

Longer version string of the OS that may have the distrobution name in it.

os_nodestring

The network node name if available.

os_platformstring

Full platform build numbers, etc.

os_unamearray

Full uname dump of all available OS data.

os_archstring

Remote architecture type.

os_uuidstring

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_idstring

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serialstring

DMI serial number

os_uptime_datestring

System uptime in date format.

os_uptime_daysinteger

System uptime in days

os_memoryobject

System memory information.

os_cpuobject

System CPU information.

os_dmi_dataobject

System hardware/DMI information.

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Allows users to update a host (such as credentials to use, active or not, host aliases, and tags).

Allows users to update a host (such as credentials to use, active or not, host aliases, and tags).

 
puthttps://localhost/v1/hosts/host_id
curl --request PUT \
  --url https://localhost/v1/hosts/host_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://localhost/v1/hosts/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/hosts/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/host_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

Unique host_id to update.

Body Params

active
boolean

Boolean flag if this host is treated as active or not by the system.

tags
array of strings

An array of tags for this host.

host_alias
string

An alias this host may be known by.

ssh_port
int32

SSH port to use for authentication.

Response

Host information updated.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with update request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes a host.

This deletes a registered host by hostname or host ID.

 
deletehttps://localhost/v1/hosts/host_id
curl --request DELETE \
  --url https://localhost/v1/hosts/host_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://localhost/v1/hosts/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/hosts/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/host_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id delete.

Response

Host deleted

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with delete request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all registered hosts.

This gets all registered hosts.

 
gethttps://localhost/v1/hosts
curl --request GET \
  --url https://localhost/v1/hosts
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/hosts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/hosts");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Host information retrieved

activeboolean

Is this host active (valid credentials and login)?

authentication_statusstring

What is the state of the authentication? ok, failed, error

dataobject

Raw data of system information collected.

date_first_seenstring

Date first saw this host.

date_last_seenstring

Last time we saw this host.

first_seen_ip_addrstring

First IP address we saw for this host.

last_seen_ip_addrstring

Last IP address we saw for this host.

host_aliasstring

A host alias which can be assigned by the GUI.

tagsarray

A list of tags for this host.

host_idstring

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_namestring

The hostname or IP of the host.

os_systemstring

Generic OS name

os_releasestring

Remote kernel/os version we saw.

os_machinestring

Other machine hardware identifier.

os_versionstring

Longer version string of the OS that may have the distrobution name in it.

os_nodestring

The network node name if available.

os_platformstring

Full platform build numbers, etc.

os_unamearray

Full uname dump of all available OS data.

os_archstring

Remote architecture type.

os_uuidstring

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_idstring

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serialstring

DMI serial number

os_uptime_datestring

System uptime in date format.

os_uptime_daysinteger

System uptime in days

os_memoryobject

System memory information.

os_cpuobject

System CPU information.

os_dmi_dataobject

System hardware/DMI information.

Hosts not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Adds a host

This adds a new host.

 
posthttps://localhost/v1/hosts
curl --request POST \
  --url https://localhost/v1/hosts
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/hosts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/hosts");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

ip_network
string

IP network to scan. A class C with subnet mask.

ip_list
array of strings

An array of IP addresses or hostnames to scan.

credentials_id
string

credentials_id to use from credentials API for logging in and adding this host.

ssh_port
int32

SSH port to use for authentication.

Response

Host information accepted for processing.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with host add.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all registered hosts marked as active.

This gets all registered hosts marked as active.

 
gethttps://localhost/v1/hosts/active
curl --request GET \
  --url https://localhost/v1/hosts/active
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/hosts/active' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/hosts/active");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/active"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Host information retrieved

activeboolean

Is this host active (valid credentials and login)?

authentication_statusstring

What is the state of the authentication? ok, failed, error

dataobject

Raw data of system information collected.

date_first_seenstring

Date first saw this host.

date_last_seenstring

Last time we saw this host.

first_seen_ip_addrstring

First IP address we saw for this host.

last_seen_ip_addrstring

Last IP address we saw for this host.

host_aliasstring

A host alias which can be assigned by the GUI.

tagsarray

A list of tags for this host.

host_idstring

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_namestring

The hostname or IP of the host.

os_systemstring

Generic OS name

os_releasestring

Remote kernel/os version we saw.

os_machinestring

Other machine hardware identifier.

os_versionstring

Longer version string of the OS that may have the distrobution name in it.

os_nodestring

The network node name if available.

os_platformstring

Full platform build numbers, etc.

os_unamearray

Full uname dump of all available OS data.

os_archstring

Remote architecture type.

os_uuidstring

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_idstring

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serialstring

DMI serial number

os_uptime_datestring

System uptime in date format.

os_uptime_daysinteger

System uptime in days

os_memoryobject

System memory information.

os_cpuobject

System CPU information.

os_dmi_dataobject

System hardware/DMI information.

Hosts not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

HostsSystem

 
Suggest Edits

Allows system to update a host (such as last seen time and IP address).

Allows system to update a host (such as last seen time and IP address).

 
puthttps://localhost/v1/hosts/system/host_id
curl --request PUT \
  --url https://localhost/v1/hosts/system/host_id
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/hosts/system/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/system/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/hosts/system/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/system/host_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

Unique host_id to update.

Body Params

active
boolean

Is this host active (valid credentials and login)?

authentication_status
string

What is the state of the authentication? ok, failed, error

data
object

Raw data of system information collected.

 
date_first_seen
date-time

Date first saw this host.

date_last_seen
date-time

Last time we saw this host.

first_seen_ip_addr
string

First IP address we saw for this host.

last_seen_ip_addr
string

Last IP address we saw for this host.

host_alias
string

A host alias which can be assigned by the GUI.

tags
array of strings

A list of tags for this host.

host_id
string

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_name
string

The hostname or IP of the host.

os_system
string

Generic OS name

os_release
string

Remote kernel/os version we saw.

os_machine
string

Other machine hardware identifier.

os_version
string

Longer version string of the OS that may have the distrobution name in it.

os_node
string

The network node name if available.

os_platform
string

Full platform build numbers, etc.

os_uname
array of strings

Full uname dump of all available OS data.

os_arch
string

Remote architecture type.

os_uuid
string

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_id
string

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serial
string

DMI serial number

os_uptime_date
date-time

System uptime in date format.

os_uptime_days
integer

System uptime in days

os_memory
object

System memory information.

 
os_cpu
object

System CPU information.

 
os_dmi_data
object

System hardware/DMI information.

 

Response

Host information updated.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with update request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Allows backend system to add a host after initial os_identify scan.

Allows backend system to add a host after initial os_identify scan.

 
posthttps://localhost/v1/hosts/system/host_id
curl --request POST \
  --url https://localhost/v1/hosts/system/host_id
var request = require("request");

var options = { method: 'POST',
  url:
   'https://localhost/v1/hosts/system/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/system/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/hosts/system/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/system/host_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

Unique host_id to insert.

Body Params

active
boolean

Is this host active (valid credentials and login)?

authentication_status
string

What is the state of the authentication? ok, failed, error

data
object

Raw data of system information collected.

 
date_first_seen
date-time

Date first saw this host.

date_last_seen
date-time

Last time we saw this host.

first_seen_ip_addr
string

First IP address we saw for this host.

last_seen_ip_addr
string

Last IP address we saw for this host.

host_alias
string

A host alias which can be assigned by the GUI.

tags
array of strings

A list of tags for this host.

host_id
string

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_name
string

The hostname or IP of the host.

os_system
string

Generic OS name

os_release
string

Remote kernel/os version we saw.

os_machine
string

Other machine hardware identifier.

os_version
string

Longer version string of the OS that may have the distrobution name in it.

os_node
string

The network node name if available.

os_platform
string

Full platform build numbers, etc.

os_uname
array of strings

Full uname dump of all available OS data.

os_arch
string

Remote architecture type.

os_uuid
string

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_id
string

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serial
string

DMI serial number

os_uptime_date
date-time

System uptime in date format.

os_uptime_days
integer

System uptime in days

os_memory
object

System memory information.

 
os_cpu
object

System CPU information.

 
os_dmi_data
object

System hardware/DMI information.

 

Response

Host information added.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with create request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets hosts by tag name.

Gets all hosts with the tag name provided.

 
gethttps://localhost/v1/hosts/tags/tag_id
curl --request GET \
  --url https://localhost/v1/hosts/tags/tag_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/hosts/tags/tag_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/hosts/tags/tag_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/hosts/tags/tag_id");

xhr.send(data);
import requests

url = "https://localhost/v1/hosts/tags/tag_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

tag_id
string
required

tagged hosts to retrieve

Response

Host information retrieved

activeboolean

Is this host active (valid credentials and login)?

authentication_statusstring

What is the state of the authentication? ok, failed, error

dataobject

Raw data of system information collected.

date_first_seenstring

Date first saw this host.

date_last_seenstring

Last time we saw this host.

first_seen_ip_addrstring

First IP address we saw for this host.

last_seen_ip_addrstring

Last IP address we saw for this host.

host_aliasstring

A host alias which can be assigned by the GUI.

tagsarray

A list of tags for this host.

host_idstring

A unique ID for this host (ssh key fingerprint), or the host_name if we saw no SSH.

host_namestring

The hostname or IP of the host.

os_systemstring

Generic OS name

os_releasestring

Remote kernel/os version we saw.

os_machinestring

Other machine hardware identifier.

os_versionstring

Longer version string of the OS that may have the distrobution name in it.

os_nodestring

The network node name if available.

os_platformstring

Full platform build numbers, etc.

os_unamearray

Full uname dump of all available OS data.

os_archstring

Remote architecture type.

os_uuidstring

A UUID can be unique to this host, but on virtual machine images it may not be unique.

os_machine_idstring

A machine id that some systems will provide that is unique to that host.

os_dmi_product_serialstring

DMI serial number

os_uptime_datestring

System uptime in date format.

os_uptime_daysinteger

System uptime in days

os_memoryobject

System memory information.

os_cpuobject

System CPU information.

os_dmi_dataobject

System hardware/DMI information.

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No hosts found for that tag.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Scan a remote host by host_id.

Scan a remote host by host_id.

 
posthttps://localhost/v1/scan/host_id
curl --request POST \
  --url https://localhost/v1/scan/host_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/scan/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/scan/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/scan/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/scan/host_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to scan.

Body Params

sandfly_list
array of strings

A list of sandflies to use in the scan.

Response

Remote scan accepted for processing.

A supplied sandfly in a list was not found or other error happened.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

host_id for scan was not found in hosts table.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Authentication

 
Suggest Edits

Gets authentication token.

Gets authentication token.

 
posthttps://localhost/v1/auth/login
curl --request POST \
  --url https://localhost/v1/auth/login
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/auth/login' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/auth/login");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/login"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

username
string

username string

password
password

password string

Response

Login valid

access_tokenstring

Access token

refresh_tokenstring

Refresh token.

Error during login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Invalid login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets fresh authentication token.

Gets fresh authentication token.

 
posthttps://localhost/v1/auth/login_fresh
curl --request POST \
  --url https://localhost/v1/auth/login_fresh
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/auth/login_fresh' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/login_fresh")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/auth/login_fresh");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/login_fresh"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

username
string

username string

password
password

password string

Response

Login valid

access_tokenstring

Access token

Error during login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Invalid login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets new authentication token but marks old one as non-fresh.

Gets new authentication token but marks old one as non-fresh.

 
posthttps://localhost/v1/auth/login_refresh
curl --request POST \
  --url https://localhost/v1/auth/login_refresh
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/auth/login_refresh' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/login_refresh")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/auth/login_refresh");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/login_refresh"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Login valid

access_tokenstring

Access token

Error during login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Invalid login

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Adds a user

Adds a user.

 
posthttps://localhost/v1/auth/users
curl --request POST \
  --url https://localhost/v1/auth/users
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/auth/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/auth/users");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/users"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

username
string

username string

password
password

password string

Response

User added.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error adding user.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all users.

Gets all users

 
gethttps://localhost/v1/auth/users
curl --request GET \
  --url https://localhost/v1/auth/users
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/auth/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/auth/users");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Users retrieved.

usernamestring

username string

passwordstring

Encrypted password string (may be masked by system for security reasons)

notesstring

Notes about this user like full name, purpose, etc.

groupsarray

Groups this user belongs to.

created_datestring

Date this user was created

last_login_datestring

Last login date/time for this user.

last_login_ipstring

Last login IP address we saw this user.

loginsarray

An comma delimited array of the dates and locations this user has ever logged in from.

logins_failedarray

An comma delimited array of the dates and locations this user has failed logged in from.

logins_failed_countinteger

A counter of the number of failed logins from the last successful login. Used to detect brute forcers.

Error getting users.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets a user.

Gets a user.

 
gethttps://localhost/v1/auth/users/username
curl --request GET \
  --url https://localhost/v1/auth/users/username
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/auth/users/username' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/users/username")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/auth/users/username");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/users/username"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

username
string
required

username to get

Response

User data.

usernamestring

username string

passwordstring

Encrypted password string (may be masked by system for security reasons)

notesstring

Notes about this user like full name, purpose, etc.

groupsarray

Groups this user belongs to.

created_datestring

Date this user was created

last_login_datestring

Last login date/time for this user.

last_login_ipstring

Last login IP address we saw this user.

loginsarray

An comma delimited array of the dates and locations this user has ever logged in from.

logins_failedarray

An comma delimited array of the dates and locations this user has failed logged in from.

logins_failed_countinteger

A counter of the number of failed logins from the last successful login. Used to detect brute forcers.

Error getting user.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes a user.

Deletes a user.

 
deletehttps://localhost/v1/auth/users/username
curl --request DELETE \
  --url https://localhost/v1/auth/users/username
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/auth/users/username' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/users/username")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/auth/users/username");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/users/username"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

username
string
required

username to delete

Response

User deleted.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error deleting user.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Updates a user password.

Updates a user password.

 
puthttps://localhost/v1/auth/users/password/username
curl --request PUT \
  --url https://localhost/v1/auth/users/password/username
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/auth/users/password/username' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/auth/users/password/username")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/auth/users/password/username");

xhr.send(data);
import requests

url = "https://localhost/v1/auth/users/password/username"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

username
string
required

username to update password

Body Params

username
string

username string

password
password

password string

Response

User password updated.

usernamestring

username string

passwordstring

Encrypted password string (may be masked by system for security reasons)

notesstring

Notes about this user like full name, purpose, etc.

groupsarray

Groups this user belongs to.

created_datestring

Date this user was created

last_login_datestring

Last login date/time for this user.

last_login_ipstring

Last login IP address we saw this user.

loginsarray

An comma delimited array of the dates and locations this user has ever logged in from.

logins_failedarray

An comma delimited array of the dates and locations this user has failed logged in from.

logins_failed_countinteger

A counter of the number of failed logins from the last successful login. Used to detect brute forcers.

Error updating user.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

User not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Sandflies

 
Suggest Edits

Gets all registered sandflies

This gets all registered sandflies.

 
gethttps://localhost/v1/sandflies
curl --request GET \
  --url https://localhost/v1/sandflies
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/sandflies' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Sandfly information retrieved

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No sandflies found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Reloads all sandflies in server's sandfly directory and activates them.

This method will reload all sandflies in the server directory and activate them.

 
posthttps://localhost/v1/sandflies/reload_all
curl --request POST \
  --url https://localhost/v1/sandflies/reload_all
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/sandflies/reload_all' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/reload_all")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/sandflies/reload_all");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/reload_all"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Reloading sandlflies and adding them to DB as active for scanning.

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error inserting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Loads new sandflies in server's sandfly directory and activates them.

Loads new sandflies in server's sandfly directory and activates them.

 
posthttps://localhost/v1/sandflies/load_new
curl --request POST \
  --url https://localhost/v1/sandflies/load_new
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/sandflies/load_new' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/load_new")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/sandflies/load_new");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/load_new"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Loaded new sandflies in server's sandfly directory and activated them.

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error inserting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No sandflies found to load.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all active sandflies

This gets all active sandflies.

 
gethttps://localhost/v1/sandflies/active
curl --request GET \
  --url https://localhost/v1/sandflies/active
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/sandflies/active' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/active");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/active"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Active sandfly information retrieved

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Active sandflies not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all inactive sandflies

This gets all inactive sandflies.

 
gethttps://localhost/v1/sandflies/inactive
curl --request GET \
  --url https://localhost/v1/sandflies/inactive
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/sandflies/inactive' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/inactive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/inactive");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/inactive"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Inactive sandfly information retrieved

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Inactive sandflies not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all types of registered sandflies.

Gets all types of registered sandflies.

 
gethttps://localhost/v1/sandflies/types
curl --request GET \
  --url https://localhost/v1/sandflies/types
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/sandflies/types' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/types");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/types"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Sandfly types in list format

sandfly_typesarray

List of sandfly types registered with the system.

Error getting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Sandflies with that type not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets sandflies of a given type.

This gets all sandflies with a given type.

 
gethttps://localhost/v1/sandflies/types/sandfly_type
curl --request GET \
  --url https://localhost/v1/sandflies/types/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/sandflies/types/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/types/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/types/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/types/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

type of sandflies to retrieve

Response

Sandfly information retrieved with the type

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Sandflies with that type not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets sandfly with the supplied name.

Gets sandfly with the supplied name.

 
gethttps://localhost/v1/sandflies/name/sandfly_name
curl --request GET \
  --url https://localhost/v1/sandflies/name/sandfly_name
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/sandflies/name/sandfly_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/name/sandfly_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/name/sandfly_name");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/name/sandfly_name"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

Sandfly name to retrieve

Response

Sandfly information retrieved

activeboolean

Is this sandfly active for use?

descriptionstring

Sandfly description.

date_addedstring

The date that this sandfly was added to the DB.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Sandfly name not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Activates a sandfly by name.

Activates a sandfly by name.

 
puthttps://localhost/v1/sandflies/name/sandfly_name/activate
curl --request PUT \
  --url https://localhost/v1/sandflies/name/sandfly_name/activate
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/sandflies/name/sandfly_name/activate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/name/sandfly_name/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/sandflies/name/sandfly_name/activate");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/name/sandfly_name/activate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

sandfly name to activate.

Response

Activated sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error activating sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Sandfly name not found to activate.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Dectivates a sandfly by name.

Dectivates a sandfly by name.

 
puthttps://localhost/v1/sandflies/name/sandfly_name/deactivate
curl --request PUT \
  --url https://localhost/v1/sandflies/name/sandfly_name/deactivate
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/sandflies/name/sandfly_name/deactivate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/name/sandfly_name/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/sandflies/name/sandfly_name/deactivate");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/name/sandfly_name/deactivate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

sandfly name to deactivate.

Response

Deactivated sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error deactivating sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Sandfly name not found to deactivate.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

SandfliesCustom

 
Suggest Edits

Gets all registered custom sandflies

This gets all registered custom sandflies.

 
gethttps://localhost/v1/sandflies/custom
curl --request GET \
  --url https://localhost/v1/sandflies/custom
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/sandflies/custom' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Custom Sandfly information retrieved

namestring

Sandfly name.

descriptionstring

Sandfly description.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No custom sandflies found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Adds a custom sandfly

This adds a custom sandfly.

 
posthttps://localhost/v1/sandflies/custom
curl --request POST \
  --url https://localhost/v1/sandflies/custom
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/sandflies/custom' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/sandflies/custom");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string

Sandfly name.

description
string

Sandfly description.

version
string

Version of this Sandfly.

type
string

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compat
object

JSON object of the operating systems this sandfly will run on.

 
max_timeout
int32

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_load
int32

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_load
int32

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtual
boolean

Is this a virtual sandfly?

virtual_options
object

Virtual sandfly options.

 

Response

Added

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Update a custom sandfly

This updates a custom sandfly.

 
puthttps://localhost/v1/sandflies/custom
curl --request PUT \
  --url https://localhost/v1/sandflies/custom
var request = require("request");

var options = { method: 'PUT', url: 'https://localhost/v1/sandflies/custom' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/sandflies/custom");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string

Sandfly name.

description
string

Sandfly description.

version
string

Version of this Sandfly.

type
string

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compat
object

JSON object of the operating systems this sandfly will run on.

 
max_timeout
int32

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_load
int32

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_load
int32

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtual
boolean

Is this a virtual sandfly?

virtual_options
object

Virtual sandfly options.

 

Response

Updated

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all active custom sandflies

This gets all active custom sandflies.

 
gethttps://localhost/v1/sandflies/custom/active
curl --request GET \
  --url https://localhost/v1/sandflies/custom/active
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/sandflies/custom/active' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/active")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/active");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/active"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Active custom sandfly information retrieved

namestring

Sandfly name.

descriptionstring

Sandfly description.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Active custom sandflies not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all inactive custom sandflies

This gets all inactive custom sandflies.

 
gethttps://localhost/v1/sandflies/custom/inactive
curl --request GET \
  --url https://localhost/v1/sandflies/custom/inactive
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/sandflies/custom/inactive' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/inactive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/inactive");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/inactive"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Inactive custom sandfly information retrieved

namestring

Sandfly name.

descriptionstring

Sandfly description.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Inactive custom sandflies not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all types of registered custom sandflies.

Gets all types of registered custom sandflies.

 
gethttps://localhost/v1/sandflies/custom/types
curl --request GET \
  --url https://localhost/v1/sandflies/custom/types
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/sandflies/custom/types' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/types")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/types");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/types"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Sandfly custom types in list format

sandfly_typesarray

List of sandfly types registered with the system.

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Custom sandflies with that type not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets custom sandflies of a given type.

This gets all custom sandflies with a given type.

 
gethttps://localhost/v1/sandflies/custom/types/sandfly_type
curl --request GET \
  --url https://localhost/v1/sandflies/custom/types/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/sandflies/custom/types/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/types/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/types/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/types/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

type of custom sandflies to retrieve

Response

Custom sandfly information retrieved with the type

namestring

Sandfly name.

descriptionstring

Sandfly description.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Custom sandflies with that type not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets custom sandfly with the supplied name.

Gets custom sandfly with the supplied name.

 
gethttps://localhost/v1/sandflies/custom/name/sandfly_name
curl --request GET \
  --url https://localhost/v1/sandflies/custom/name/sandfly_name
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/sandflies/custom/name/sandfly_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/name/sandfly_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/name/sandfly_name");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/name/sandfly_name"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

Custom sandfly name to retrieve

Response

Custom sandfly information retrieved

namestring

Sandfly name.

descriptionstring

Sandfly description.

versionstring

Version of this Sandfly.

typestring

What kind of sandfly is this (directory, file, user, dependency, recon)?

os_compatobject

JSON object of the operating systems this sandfly will run on.

max_timeoutinteger

What is the longest we should wait for this sandfly to return data in seconds?

max_cpu_loadinteger

The amount of relative CPU intensity this sandfly needs (1 - low, 3 - high)

max_disk_loadinteger

he amount of relative disk intensity this sandfly needs (1 - low, 3 - high)

virtualboolean

Is this a virtual sandfly?

virtual_optionsobject

Virtual sandfly options.

Error getting custom sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Custom sandfly name not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes a custom sandfly entry.

Deletes a custom sandfly entry.

 
deletehttps://localhost/v1/sandflies/custom/name/sandfly_name
curl --request DELETE \
  --url https://localhost/v1/sandflies/custom/name/sandfly_name
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/sandflies/custom/name/sandfly_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/name/sandfly_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/sandflies/custom/name/sandfly_name");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/name/sandfly_name"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

sandfly name to delete

Response

Custom sandfly entry deleted.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error deleting custom sandfly entry.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Activates a custom sandfly by name.

Activates a custom sandfly by name.

 
puthttps://localhost/v1/sandflies/custom/name/sandfly_name/activate
curl --request PUT \
  --url https://localhost/v1/sandflies/custom/name/sandfly_name/activate
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/sandflies/custom/name/sandfly_name/activate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/name/sandfly_name/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/sandflies/custom/name/sandfly_name/activate");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/name/sandfly_name/activate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

sandfly name to activate.

Response

Activated custom sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error activating custom sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Custom sandfly name not found to activate.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Dectivates a custom sandfly by name.

Dectivates a custom sandfly by name.

 
puthttps://localhost/v1/sandflies/custom/name/sandfly_name/deactivate
curl --request PUT \
  --url https://localhost/v1/sandflies/custom/name/sandfly_name/deactivate
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://localhost/v1/sandflies/custom/name/sandfly_name/deactivate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/name/sandfly_name/deactivate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://localhost/v1/sandflies/custom/name/sandfly_name/deactivate");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/name/sandfly_name/deactivate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_name
string
required

sandfly name to deactivate.

Response

Deactivated custom sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error deactivating custom sandfly.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Custom sandfly name not found to deactivate.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Backup all registered custom sandflies

This displays all registered custom sandflies as a big JSON object for backup purposes.

 
gethttps://localhost/v1/sandflies/custom/backup
curl --request GET \
  --url https://localhost/v1/sandflies/custom/backup
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/sandflies/custom/backup' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/sandflies/custom/backup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/sandflies/custom/backup");

xhr.send(data);
import requests

url = "https://localhost/v1/sandflies/custom/backup"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Custom Sandfly information retrieved

Error getting custom sandflies.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No custom sandflies found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets the audit log.

Gets the audit log.

 
gethttps://localhost/v1/audit
curl --request GET \
  --url https://localhost/v1/audit
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/audit' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/audit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/audit");

xhr.send(data);
import requests

url = "https://localhost/v1/audit"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Audit log retrieved

timestampstring

Timestamp for log entry.

usernamestring

Username associated with this log entry.

ip_addrstring

IP address associated with this log entry.

record_typestring

Audit event type (security, system, etc.)

messagestring

Audit event details.

Error getting audit log.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No audit log found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes the audit log.

Deletes the audit log.

 
deletehttps://localhost/v1/audit
curl --request DELETE \
  --url https://localhost/v1/audit
var request = require("request");

var options = { method: 'DELETE', url: 'https://localhost/v1/audit' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/audit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/audit");

xhr.send(data);
import requests

url = "https://localhost/v1/audit"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Audit log deleted

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error getting audit log.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No audit log found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets keyword mappings of all indices.

Gets keyword mappings of all indices.

 
gethttps://localhost/v1/search/mappings/index_name
curl --request GET \
  --url https://localhost/v1/search/mappings/index_name
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/search/mappings/index_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/mappings/index_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/search/mappings/index_name");

xhr.send(data);
import requests

url = "https://localhost/v1/search/mappings/index_name"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

index_name
string
required

index name to retrieve keyword mappings (e.g. results, hosts)

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results by search term anywhere.

Gets results by search term anywhere.

 
posthttps://localhost/v1/search/results
curl --request POST \
  --url https://localhost/v1/search/results
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/results' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/results");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results by key and value.

Gets results by key and value.

 
posthttps://localhost/v1/search/results/keyvalue
curl --request POST \
  --url https://localhost/v1/search/results/keyvalue
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/search/results/keyvalue' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results/keyvalue")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/results/keyvalue");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results/keyvalue"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are type X that failed and are open state.

Gets a result that are type X that failed and are open state.

 
gethttps://localhost/v1/search/results/type/fail/sandfly_type
curl --request GET \
  --url https://localhost/v1/search/results/type/fail/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/search/results/type/fail/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results/type/fail/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/search/results/type/fail/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results/type/fail/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

type of sandfly ("directory", "file", "user", etc.)

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are sandfly_type X that passed and are open state.

Gets a result that are sandfly_type X that passed and are open state.

 
gethttps://localhost/v1/search/results/type/pass/sandfly_type
curl --request GET \
  --url https://localhost/v1/search/results/type/pass/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/search/results/type/pass/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results/type/pass/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/search/results/type/pass/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results/type/pass/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

sandfly_type value such as "directory", "file", "user", etc.

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are sandfly_type X that had an error and are open state.

Gets a result that are sandfly_type X that had an error and are open state.

 
gethttps://localhost/v1/search/results/type/error/sandfly_type
curl --request GET \
  --url https://localhost/v1/search/results/type/error/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/search/results/type/error/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results/type/error/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/search/results/type/error/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results/type/error/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

sandfly_type such as "directory", "user", "file", etc.

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are sandfly_type X of pass, fail, or error and are open state.

Gets results that are sandfly_type X of pass, fail, or error and are open state.

 
gethttps://localhost/v1/search/results/type/all/sandfly_type
curl --request GET \
  --url https://localhost/v1/search/results/type/all/sandfly_type
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/search/results/type/all/sandfly_type' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/results/type/all/sandfly_type")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/search/results/type/all/sandfly_type");

xhr.send(data);
import requests

url = "https://localhost/v1/search/results/type/all/sandfly_type"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

sandfly_type
string
required

sandfly_type such as "directory", "file", "user", etc.

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Search hosts for any term.

Search hosts for any term.

 
posthttps://localhost/v1/search/hosts
curl --request POST \
  --url https://localhost/v1/search/hosts
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/hosts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/hosts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/hosts");

xhr.send(data);
import requests

url = "https://localhost/v1/search/hosts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets hosts by supplied key/value pair

Gets a host or hosts by a supplied key/value pair

 
posthttps://localhost/v1/search/hosts/keyvalue
curl --request POST \
  --url https://localhost/v1/search/hosts/keyvalue
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/search/hosts/keyvalue' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/hosts/keyvalue")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/hosts/keyvalue");

xhr.send(data);
import requests

url = "https://localhost/v1/search/hosts/keyvalue"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets audit log by supplied key/value pair

Gets a audit log by a supplied key/value pair

 
posthttps://localhost/v1/search/audit
curl --request POST \
  --url https://localhost/v1/search/audit
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/audit' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/audit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/audit");

xhr.send(data);
import requests

url = "https://localhost/v1/search/audit"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets error log by supplied key/value pair

Gets error log by a supplied key/value pair

 
posthttps://localhost/v1/search/errors
curl --request POST \
  --url https://localhost/v1/search/errors
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/errors' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/errors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/errors");

xhr.send(data);
import requests

url = "https://localhost/v1/search/errors"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets sandflies by supplied key/value pair

Gets sandflies by a supplied key/value pair

 
posthttps://localhost/v1/search/sandflies
curl --request POST \
  --url https://localhost/v1/search/sandflies
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/sandflies' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/sandflies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/sandflies");

xhr.send(data);
import requests

url = "https://localhost/v1/search/sandflies"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets credentials by supplied key/value pair

Gets credentials by a supplied key/value pair

 
posthttps://localhost/v1/search/credentials
curl --request POST \
  --url https://localhost/v1/search/credentials
var request = require("request");

var options = { method: 'POST',
  url: 'https://localhost/v1/search/credentials' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/credentials");

xhr.send(data);
import requests

url = "https://localhost/v1/search/credentials"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets schedule by supplied key/value pair

Gets schedule by a supplied key/value pair

 
posthttps://localhost/v1/search/schedule
curl --request POST \
  --url https://localhost/v1/search/schedule
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/search/schedule' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/search/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/search/schedule");

xhr.send(data);
import requests

url = "https://localhost/v1/search/schedule"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Results returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
 
Suggest Edits

System API call to add a result.

This allows the system to add a result.

 
posthttps://localhost/v1/results/system
curl --request POST \
  --url https://localhost/v1/results/system
var request = require("request");

var options = { method: 'POST', url: 'https://localhost/v1/results/system' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/system")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://localhost/v1/results/system");

xhr.send(data);
import requests

url = "https://localhost/v1/results/system"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Added result.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error inserting results.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all results for a unique doc_id

Gets all results for a unique doc_id

 
gethttps://localhost/v1/results/doc_id
curl --request GET \
  --url https://localhost/v1/results/doc_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/results/doc_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/doc_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/doc_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/doc_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

doc_id
string
required

doc_id to retrieve from results.

Response

Results doc_id retrieved

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

doc_id not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes all results for a unique document_id

Deletes all results for a unique document_id

 
deletehttps://localhost/v1/results/doc_id
curl --request DELETE \
  --url https://localhost/v1/results/doc_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://localhost/v1/results/doc_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/doc_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/results/doc_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/doc_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

doc_id
string
required

doc_id to delete from results.

Response

Deleted result.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with delete request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

doc_id not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are failures since a specified time.

Gets results that are failures since a specified time.

 
gethttps://localhost/v1/results/time/failure
curl --request GET \
  --url https://localhost/v1/results/time/failure
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/results/time/failure' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/time/failure")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/time/failure");

xhr.send(data);
import requests

url = "https://localhost/v1/results/time/failure"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

search_time_since
date-time

A correctly formatted time entry for searching.

Response

Status of failures found

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are passes since a specified time.

Gets results that are passes since a specified time.

 
gethttps://localhost/v1/results/time/pass
curl --request GET \
  --url https://localhost/v1/results/time/pass
var request = require("request");

var options = { method: 'GET', url: 'https://localhost/v1/results/time/pass' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/time/pass")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/time/pass");

xhr.send(data);
import requests

url = "https://localhost/v1/results/time/pass"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

search_time_since
date-time

A correctly formatted time entry for searching.

Response

Status of passes found

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are errors since a specified time.

Gets results that are errors since a specified time.

 
gethttps://localhost/v1/results/time/error
curl --request GET \
  --url https://localhost/v1/results/time/error
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/results/time/error' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/time/error")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/time/error");

xhr.send(data);
import requests

url = "https://localhost/v1/results/time/error"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

search_time_since
date-time

A correctly formatted time entry for searching.

Response

Status of errors found

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are failures with unique aggregation of hosts (no duplicates)

Gets results that are failures with unique aggregation of hosts (no duplicates)

 
gethttps://localhost/v1/results/hosts/failure
curl --request GET \
  --url https://localhost/v1/results/hosts/failure
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/results/hosts/failure' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/failure")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/hosts/failure");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/failure"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Status of host failures returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all sandflies that failed for a host as an aggregation result.

Gets all sandflies that failed for a host as an aggregation result.

 
gethttps://localhost/v1/results/hosts/failure/host_id
curl --request GET \
  --url https://localhost/v1/results/hosts/failure/host_id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/results/hosts/failure/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/failure/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/hosts/failure/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/failure/host_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to get failed sandflies on.

Response

Host failed sandfly information retrieved

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes all results that failed for a host.

Deletes all results that failed for a host.

 
deletehttps://localhost/v1/results/hosts/failure/host_id
curl --request DELETE \
  --url https://localhost/v1/results/hosts/failure/host_id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/results/hosts/failure/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/failure/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/results/hosts/failure/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/failure/host_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to delete results for.

Response

Deleted all host results.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all sandflies that failed for the host_id.

Gets all sandflies that failed for the host_id.

 
gethttps://localhost/v1/results/hosts/failure/host_id/sandfly_name
curl --request GET \
  --url https://localhost/v1/results/hosts/failure/host_id/sandfly_name
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/results/hosts/failure/host_id/sandfly_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/failure/host_id/sandfly_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/hosts/failure/host_id/sandfly_name");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/failure/host_id/sandfly_name"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to get failed sandflies on.

sandfly_name
string
required

failed sandfly_name to get for the host_id

Response

Results informaton retrieved.

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes all sandflies that failed for the host_id.

Deletes all sandflies that failed for the host_id.

 
deletehttps://localhost/v1/results/hosts/failure/host_id/sandfly_name
curl --request DELETE \
  --url https://localhost/v1/results/hosts/failure/host_id/sandfly_name
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/results/hosts/failure/host_id/sandfly_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/failure/host_id/sandfly_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/results/hosts/failure/host_id/sandfly_name");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/failure/host_id/sandfly_name"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to delete sandflies results on.

sandfly_name
string
required

sandfly_name results to delete for the host_id

Response

Sandfly results deleted for host_id.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets results that are pass with unique aggregation of hosts (no duplicates)

Gets results that are pass with unique aggregation of hosts (no duplicates)

 
gethttps://localhost/v1/results/hosts/pass
curl --request GET \
  --url https://localhost/v1/results/hosts/pass
var request = require("request");

var options = { method: 'GET',
  url: 'https://localhost/v1/results/hosts/pass' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/pass")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/hosts/pass");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/pass"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

Status of host passes returned

Unexpected error

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

No results found

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Gets all sandflies that passed for a host as an aggregation result.

Gets all sandflies that passed for a host as an aggregation result.

 
gethttps://localhost/v1/results/hosts/pass/host_id
curl --request GET \
  --url https://localhost/v1/results/hosts/pass/host_id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://localhost/v1/results/hosts/pass/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/pass/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://localhost/v1/results/hosts/pass/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/pass/host_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to get passed sandflies on.

Response

Host pass sandfly results retrieved

Error with get request.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Host not found.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.

Unexpected error

codeinteger
messagestring
fieldsstring
Suggest Edits

Deletes all results that passed for a host.

Deletes all results that passed for a host.

 
deletehttps://localhost/v1/results/hosts/pass/host_id
curl --request DELETE \
  --url https://localhost/v1/results/hosts/pass/host_id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://localhost/v1/results/hosts/pass/host_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://localhost/v1/results/hosts/pass/host_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://localhost/v1/results/hosts/pass/host_id");

xhr.send(data);
import requests

url = "https://localhost/v1/results/hosts/pass/host_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

host_id
string
required

host_id to delete results for.

Response

Deleted all host pass results.

codeinteger

HTTP status code.

messagestring

Any message about the status code.

statusstring

Status success, error, failure

datastring

Data that can go along with the status.