API Reference
Log In
API Reference
These docs are for v29. Click to read the latest docs for v33.

/host-store/api/v1/hosts/search

post
https://example.com/host-store/api/v1/hosts/search

Search for hosts

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

Offset from which to start fetching objects

integer
Defaults to 50

Maximum number of objects to return

string
Defaults to id

Sort by specific object property

string
enum
Defaults to ASC

Sort direction, asc or desc

Allowed:
string

Filter hosts - possible values: accessible (filter hosts based on whether the current user has access to them)

Body Params
boolean

Ignores the disabled hosts - when enabled, host search searches for disabled hosts as well

string

Comma or space-separated strings to search across all host attributes. The leading and trailing wildcards for the keywords are implicit.

distinguished_name
array of strings

A comma separated list of strings to search for

distinguished_name
string

The external id of the host

string

The instance id from the cloud service

string

The source of the host

common_name
array of strings

An array of strings to search for

common_name
organization
array of strings

An array of strings to search for

organization
organizational_unit
array of strings

An array of strings to search for

organizational_unit
address
array of strings

An array of strings to search for

address
access_group_ids
array of uuids

An array of access group IDs to search for

access_group_ids
service
array of strings

An array of service types to search for (SSH, RDP, WEB)

service
port
array of integers

An array of integers to search for

port
zone
array of strings

An array of strings to search for

zone
host_type
array of strings

An array of strings to search for

host_type
host_classification
array of strings

An array of strings to search for

host_classification
role
array of strings

An array of strings to search for (role id's)

role
scope
array of strings

An array of strings to search for

scope
tags
array of strings

An array of host tags to search for

tags
cloud_providers
array of strings

An array of cloud provider names to search (AWS,GOOGLECLOUD,AZURE,OPENSTACK)

cloud_providers
cloud_provider_regions
array of strings

An array of cloud provider regions to search for. Valid values depend on cloud provider.

cloud_provider_regions
boolean

A host deployable flag status to search for.

statuses
array of strings

An array of host status strings to search for.

statuses
Headers
string
required
Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Updated over 4 years ago

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

Updated over 4 years ago