HomeDocumentationAPI Reference
Log In
API Reference

Add hosts

post
https://{sandfly-api-host}/v4/hosts

Adds new hosts.

Body Params

Host data to use to scan for and input new hosts.

This is how we insert credentials for a target system. When inserted, they are encrypted and stored by the system. Also used by ad hoc scan for one time use credentials.

string
enum
required

A discriminator to determine which fields can be safely ignored. If left blank, the API will attempt to determine the correct configuration based on data present.

Allowed:
string
enum
Defaults to existing
deprecated
Allowed:
ip_list
array of strings
required

List of IP addresses to scan.

ip_list*
string
required

Unique name of credential

string
enum
required

Supported Credential Types.

Allowed:
string

If an external credential type, base64-encoded trusted root CA certificate for the credential provider service, if necessary.

string

If an external credential type, extra data to provide to the credential provider service.

boolean

If an external credential type, does the provider provide a unique credential per target host?

string

If an external credential type, the URL of the credential provider service.

string

This is the password we can use to login if using username credentials or needed for sudo.

string

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

string

The ssh_key_certificate if using SSH CA signed credentials.

string

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

string

This is the username we can use to login.

string

Base64-encoded PKCS#1, PKCS#8, or encrypted PKCS#8 PEM-format RSA private key. If present on a credential, when the credential is used to connect to a host, Sandfly will add an IMA signature to the scanning binary on the target host using this private key.

string

If ima_signing_key_b64 contains an encrypted PKCS#8 private key, this password will be used to decrypt it. Do not set this property if ima_signing_key_b64 is empty.

int32
Defaults to 22

SSH port to use for scanning.

tags
array of strings
Defaults to
tags
jump_hosts
array of strings

List of jump hosts, in order of connection.

jump_hosts
string
Defaults to main

Queue name to use for this host.

string

Directory to run scan from instead of the node configuration values. An empty string means no override. For the behavior of an empty string in the node config file (where an empty string means use the home directory), enter"~" here.

boolean
Defaults to false

Verify host key when connecting to a host.

ssh_host_keys
object

Expected SSH host public keys of the hosts to add. If a host key isn't provided for a host, any key will be accepted.

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago