host_search

Search object for the search request. Attributes can be comma-separated strings (or in case of keyword, comma or space-separated). Individual attributes form a AND query and multiple values within an attribute form an OR query. E.g. search "dev 10.0" translates to WHERE (field1 like %dev% OR field2 like %dev%) AND (field1 like %10.0% OR field2 like %10.0%)

ignore_disabled_sourcesboolean

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

keywordsstring

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

distinguished_namestring[]

A comma separated list of strings to search for

external_idstring

The external id of the host

instance_idstring

The instance id from the cloud service

source_idstring

The source of the host

common_namestring[]

An array of strings to search for

organizationstring[]

An array of strings to search for

organizational_unitstring[]

An array of strings to search for

addressstring[]

An array of strings to search for

access_group_idsstring<uuid>[]

An array of access group IDs to search for

servicestring[]

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

portinteger[]

An array of integers to search for

zonestring[]

An array of strings to search for

host_typestring[]

An array of strings to search for

host_classificationstring[]

An array of strings to search for

rolestring[]

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

scopestring[]

An array of strings to search for

tagsstring[]

An array of host tags to search for

cloud_providersstring[]

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

cloud_provider_regionsstring[]

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

deployableboolean

A host deployable flag status to search for.

statusesstring[]

An array of host status strings to search for.

filterstring

Host accessibility search filter

Possible values: [accessible]

host_search

{
  "ignore_disabled_sources": true,
  "keywords": "string",
  "distinguished_name": [
    "string"
  ],
  "external_id": "string",
  "instance_id": "string",
  "source_id": "string",
  "common_name": [
    "string"
  ],
  "organization": [
    "string"
  ],
  "organizational_unit": [
    "string"
  ],
  "address": [
    "string"
  ],
  "access_group_ids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "service": [
    "string"
  ],
  "port": [
    0
  ],
  "zone": [
    "string"
  ],
  "host_type": [
    "string"
  ],
  "host_classification": [
    "string"
  ],
  "role": [
    "string"
  ],
  "scope": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "cloud_providers": [
    "string"
  ],
  "cloud_provider_regions": [
    "string"
  ],
  "deployable": true,
  "statuses": [
    "string"
  ],
  "filter": "accessible"
}