/host-store/api/v1/hosts/deploy

post

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

Create, update a host in host store

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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.

ssh_host_public_keys

array of objects

ssh_host_public_keys

host_certificate_raw

string

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

contact_address

string

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

services

array of objects

services

principals

array of objects

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

principals

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

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

200Operation okay

400Bad request

401Unauthorized request, Trusted-Client credentials incorrect

403Unauthorized request

404Resource not found

500Internal server error