Get all hosts

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

Gets a list of all hosts in the system. NOTE: almost all uses of this function should use the ?summary=true parameter; the raw call without a summary parameter or with ?summary=false exists only for backward compatability.

Query Params

summary

boolean

Defaults to false

When summary is false (the default, although not recommended for most uses of this API) the "raw host JSON" is returned for each host. When summary is true (recommended), a flat set of fields containing the main host details, as well as data from SSH hunter such as key counts, zone violations, duplicate keys, etc. (not found in the summary=false response).

key_filter

integer

Only supported when summary=true. If present, restricts the host list data to the specific SSH key IDs. Only hosts with the requested SSH keys will be returned, and the SSH-related counts will only count the requested keys. When present, the top-level response object will include a key_names map providing the friendly names for each key that exists. While not modeled in this OpenAPI spec schema, this parameter accepts a comma-delimited list of multiple key IDs.

size

integer

Defaults to 10000

Only supported when summary=true. Number of results per page.

page

integer

Defaults to 1

Only supported when summary=true. Page number of results to retrieve.

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandfly-api-host/v4/hosts?summary=false&size=10000&page=1' \
3
     --header 'accept: application/json'

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

application/json

200Host information retrieved

404Hosts not found.

defaultUnexpected error