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

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

Search for hosts

Query Params

offset

integer

Defaults to 0

Offset from which to start fetching objects

limit

integer

Defaults to 50

Maximum number of objects to return

sortkey

string

Defaults to id

Sort by specific object property

sortdir

string

Defaults to ASC

Sort direction, asc or desc

filter

string

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

Body Params

ignore_disabled_sources

boolean

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

keywords

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

external_id

string

The external id of the host

instance_id

string

The instance id from the cloud service

source_id

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, VNC, DB)

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

deployable

boolean

A host deployable flag status to search for.

statuses

array of strings

An array of host status strings to search for.

statuses

Headers

Authorization

string

required

Defaults to Bearer a-proper-token-goes-here

OAuth2 token

Responses

Response body

object

count

integer

items

array of objects

items

object

uuid

access_group_id

uuid

Defines host's access group

deployable

boolean

Whether the host is writable through /deploy end point with deployment credentials

tofu

boolean

Whether the host key should be accepted and stored on first connection

stand_alone_host

boolean

Indicates it is a standalone host - bound to local host directory

external_id

string

The equipment ID from the originating equipment store

instance_id

string

The instance ID from the originating cloud service (searchable by keyword)

audit_enabled

boolean

Wheter the host is set to be audited.

session_recording_options

object

Flags to disable trail auditing for certain features when auditing is enabled

ssh_host_public_keys

array of objects

ssh_host_public_keys

object

key

string

Host public key, used to verify the identity of the accessed host

fingerprint

string

The host-key fingerprint

host_certificate_raw

string

Host certificate, used to verify that the target host is the correct one.

host_certificate

object

contact_address

string

The host public address scanning script instructs the host store to use in service address-field.

services

array of objects

services

object

service

string

Allowed protocol - SSH, RDP, VNC, WEB, DB (searchable)

SSH RDP VNC WEB DB

address

string

Service address, IPv4, IPv6 or FQDN

port

integer

Service port

use_for_password_rotation

boolean

Defaults to false

if service SSH, informs whether this service is used to rotate password

ssh_tunnel_port

integer

ssh tunnel port

source

string

Identifies the source of the services object "UI", "SCIM" or "SCAN". Deploy is also treated as "UI".

login_page_url

string

username_field_name

string

password_field_name

string

login_request_url

string

login_request_password_property

string

auth_type

string

status

string

status_updated

string

allowed_domains

array of strings

List of allowed domains

allowed_domains

service_version

string

use_legacy_cipher_suites

boolean

browser

string

object

created

date-time

When the object was created

updated

date-time

When the object was updated

certificate_template

string

Name of the certificate template used for certificate authentication for this host

principals

array of objects

What principals (target server user names/ accounts) the host has

principals

object

principal

string

The account name

rotate

boolean

Secret is rotating pasword

use_user_account

boolean

Use user account as host principal name

passphrase

string

The account static passphrase or the initial rotating password value

username_attribute

string

Custom username attribute

source

string

Identifies the source of the principals object "UI" or "SCAN". Deploy is also treated as "UI".

roles

array of objects

An array of roles entitled to access this principal on the host

roles

object

uuid

Role UUID

name

string

Role display_name

deleted

boolean

Role is deleted

applications

array of objects

An array of application the principal may launch on the target host

applications

object

name

string

application

string

arguments

string

working_directory

string

service_options

object

Object for service options

command_restrictions

object

SSH shell/exec command restrictions for the principal

password_rotation_enabled

boolean

set, if there are accounts, in which passwords need to be rotated

password_rotation

object

password rotation settings for host

source_id

string

A unique import-source identifier for the host entry, for example a hash for AWS account ID. (searchable by keyword)

cloud_provider

string

The cloud provider this host resides in

cloud_provider_region

string

The cloud provider region the host resides in

status

array of objects

status

object

string

created

date-time

When the object was created

updated

date-time

When the object was updated

updated_by

uuid

Id of the user who updated the object

distinguished_name

string

LDAPv3 Disinguished name (searchable by keyword)

common_name

string

X.500 Common name (searchable by keyword)

organization

string

X.500 Organization (searchable by keyword)

organizational_unit

string

X.500 Organizational unit (searchable by keyword)

zone

string

Equipment zone (development, production, user acceptance testing, ..) (searchable by keyword)

scope

array of strings

Under what compliance scopes the listed equipment falls under (searchable by keyword)

scope

host_type

string

Equipment type (virtual, physical) (searchable by keyword)

host_classification

string

Classification (Windows desktop, Windows server, AIX, Linux RH, ..) (searchable by keyword)

comment

string

A comment describing the host

addresses

array of strings

addresses

tags

array of strings

tags

disabled

string

BY_ADMIN BY_LICENSE

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://example.com/host-store/api/v1/hosts/search?offset=0&limit=50&sortkey=id&sortdir=ASC' \
3
     --header 'Authorization: Bearer a-proper-token-goes-here' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Search successful, return matching hosts

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error