Update host

put

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

Allows users to update a host (such as credentials to use, host aliases, jump_hosts and tags). An active value in the request is ignored, so a whole host object can be sent back unchanged: a host's active state is maintained by Sandfly as hosts are scanned. Use POST /hosts/retry to have an inactive host checked again.

Path Params

host_id

required

Unique host_id or host_sequence_id to update.

Body Params

Parameters to update in the registered host.

credentials_id

string | null

Credential ID to use with this host.

jump_hosts

array of strings | null

Jump hosts to update on host.

jump_hosts

override_directory

string | null

Directory to run scan from instead of the node configuration values. An empty string means no override, and "~" means the directory the scan user logs in to. Any other value must be an absolute path of at most 512 characters, using only letters, digits, space, and . _ - + , @ % : = ~ /

ssh_port

int32 | null

SSH port to use with host.

queue_name

string | null

Queue (node) name to use to connect to this host.

tags

verify_host_key

boolean | null

If true, the SSH key of the host will be recorded during the Host Add operation, then on future scans Sandfly will not authenticate to the host if the host key changes.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Host information updated.

400Error with update request.

defaultUnexpected error