HomeDocumentationAPI Reference
Log In
API Reference

Get host rollup

Get a host and associated host data by host ID.

Path Params
required

host_id or host_sequence_id to retrieve.

Query Params
boolean
Defaults to false

Set to true to include the host's alerting artifacts (alerting_artifacts) in the response. It is opt-in because it is the only part of the rollup whose cost grows with the host's data, so should only be included when needed.

integer

If present, restricts the SSH key data in the ssh_summary object of the response to the specific key ID. While not modeled in this API spec, instead of a single integer key ID, this may be a comma-delimited list of key IDs to restrict to a set of keys.

Responses

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