/host-store/api/v1/hosts/resolve

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

Resolve service+address to a single host in host store

Responses

Response body

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

disable_clipboard_recording

boolean

Disable clipboard trail auditing when auditing is enabled

disable_file_transfer_recording

boolean

Disable file transfer trail auditing 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

subject

string

Certificate subject name

issuer

string

Certificate issuer name

serial

string

Certificate serial number

not_before

string

Certificate not before timestamp

not_after

string

Certificate not after timestamp

dns_names

array of strings

dns_names

email_addresses

array of strings

email_addresses

ip_addresses

array of strings

ip_addresses

fingerprint_sha1

string

Certificate SHA1 fingerprint

fingerprint_sha256

string

Certificate SHA256 fingerprint

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

access_group_id

uuid

Specify ID of access group, default access group will be used if ID is not specified. Access group will be checked for WinRM trust anchors if certificate validation option is set to enabled.

use_main_account

boolean

required

rotate passwords of all accounts in host through one account

operating_system

string

required

Bash for Linux, Powershell for windows for shell access

LINUX WINDOWS

winrm_address

string

IPv4 address or FQDN to use for winrm connections

winrm_port

integer

port to use for password rotation with winrm, zero for winrm default

protocol

string

required

SSH WINRM

certificate_validation_options

string

required

Disable or enable password rotation certificate validation

DISABLED ENABLED

winrm_host_certificate_trust_anchors

string

WinRM host certificate trust anchors in PEM format

password_policy_id

uuid

required

password policy to be applied

script_template_id

uuid

required

script template to be run in host

rotation_status

array of objects

Filled by backend. Rotation status per account to be shown in UI

rotation_status

object

principal

string

last_rotated

date-time

When last successful rotation. Added by backend

last_error

date-time

Last rotation error. Cleared when rotation successful, updated by backend

last_error_details

string

information of rotation error, updated by backend

created

date-time

When the object was created. Added by backend

updated

date-time

When the object was updated. Added by backend

created_by

string

added by backend

updated_by

string

added by backend

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

200Host successfully found, if multiple hosts match the query, return 500 internal server error with relevant error codes

400Bad request

401Unauthorized request, OAuth2 authorization missing or invalid

403Unauthorized request, OAuth2 authorization OK but scope insufficient

404Resource not found

500Internal server error