API Reference
Log In
API Reference

/host-store/api/v1/hosts/{host_id}

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

Update a single host in host store

Path Params
uuid
required
Body Params
uuid

Defines host's access group

boolean

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

boolean

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

boolean

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

string

The equipment ID from the originating equipment store

string

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

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
string

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

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
boolean

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

password_rotation
object

password rotation settings for host

string

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

string

The cloud provider this host resides in

string

The cloud provider region the host resides in

string

LDAPv3 Disinguished name (searchable by keyword)

string

X.500 Common name (searchable by keyword)

string

X.500 Organization (searchable by keyword)

string

X.500 Organizational unit (searchable by keyword)

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
string

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

string

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

string

A comment describing the host

addresses
array of strings
addresses
tags
array of strings
tags
string
enum
Allowed:
string

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

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

OAuth2 token

Responses
200

Host successfully updated

Updated over 2 years ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago