Interface HostsApiListHostsRequest

Hierarchy

  • HostsApiListHostsRequest

Properties

count? filter? from? includeHostsMetadata? includeMutedHostsData? sortDir? sortField? start?

Properties

Optional count

count?: number

Number of hosts to return. Max 1000.

Optional filter

filter?: string

String to filter search results.

Optional from

from?: number

Number of seconds since UNIX epoch from which you want to search your hosts.

Optional includeHostsMetadata

includeHostsMetadata?: boolean

Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).

Optional includeMutedHostsData

includeMutedHostsData?: boolean

Include information on the muted status of hosts and when the mute expires.

Optional sortDir

sortDir?: string

Direction of sort. Options include asc and desc.

Optional sortField

sortField?: string

Sort hosts by this field.

Optional start

start?: number

Specify the starting point for the host search results. For example, if you set count to 100 and the first 100 results have already been returned, you can set start to 101 to get the next 100 results.

Settings

Member Visibility

Theme

Generated using TypeDoc