HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get an array of hosts

Retrieve a list of host objects.

The following parameters are mutually exclusive: manager, type, vendor

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Include all host data in request:

  • nics
  • switch_ports
  • portgroups
  • vmkernel_adapters
  • vswitches
boolean

Return only the count of host objects in the result property of the response.

  • With no other parameters, this returns an object with counts for each vendor.
  • When combined with the type parameter, this only returns the integer count of objects of that type.
  • When combined with the vendor parameter, this only returns the integer count of objects of that vendor.
integer

Return the array of host objects contained in the given page number

integer

Return an array of host objects of the given size

uuids
array

Return hosts for the given list of host UUIDs.

  • Note that while the data type is array[string], the parameter value constructed by clients can be either:
  • Multiple instances of the parameter with distinct values, e.g. foo=bar&foo=baz translates to values bar and baz for parameter foo
  • One value (with no delimiter), e.g. foo=bar
  • Comma-separated list of strings, e.g. foo=bar,baz translates to the values bar and baz for parameter foo
    • NOTE: character encoding of the comma (,) character (%2C) as a delimiter is not supported
    • Parameter values can contain commas, but they must be encoded, e.g. foo=bar,baz%2Czab translates to the values bar and baz,zab for parameter foo
uuids
string
enum

Return only hosts running software supplied by the given vendor

Allowed:
int64

Return host data composed on or after the given epoch timestamp (in milliseconds); will cause requests that cannot yet be serviced to wait for recent enough host data to be built

string

Filter data results by query string

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; version=1.0