hosts

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

Search for hosts

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[string]

A comma separated list of strings to search for

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[string]

An array of strings to search for

organization

array[string]

An array of strings to search for

organizational_unit

array[string]

An array of strings to search for

address

array[string]

An array of strings to search for

access_group_ids

array[string]

An array of access group IDs to search for

service

array[string]

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

port

array[int]

An array of integers to search for

zone

array[string]

An array of strings to search for

host_type

array[string]

An array of strings to search for

host_classification

array[string]

An array of strings to search for

role

array[string]

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

scope

array[string]

An array of strings to search for

tags

array[string]

An array of host tags to search for

cloud_providers

array[string]

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

cloud_provider_regions

array[string]

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

deployable

boolean

A host deployable flag status to search for.

statuses

array[string]

An array of host status strings to search for.

Request

{
  "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": [
    "5bf77342-221c-11ee-be56-0242ac120002"
  ],
  "service": [
    "string"
  ],
  "port": [
    123
  ],
  "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"
  ]
}

Response

ExamplesSchema

Search successful, return matching hosts

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "deployable": true,
      "tofu": true,
      "stand_alone_host": true,
      "external_id": "string",
      "instance_id": "string",
      "audit_enabled": true,
      "session_recording_options": {
        "disable_clipboard_recording": true,
        "disable_file_transfer_recording": true
      },
      "ssh_host_public_keys": [
        {
          "key": "string",
          "fingerprint": "string"
        }
      ],
      "host_certificate_raw": "string",
      "host_certificate": {
        "subject": "string",
        "issuer": "string",
        "serial": "string",
        "not_before": "string",
        "not_after": "string",
        "dns_names": [
          "string"
        ],
        "email_addresses": [
          "string"
        ],
        "ip_addresses": [
          "string"
        ],
        "fingerprint_sha1": "string",
        "fingerprint_sha256": "string"
      },
      "contact_address": "string",
      "services": [
        {
          "service": "SSH",
          "address": "string",
          "port": 123,
          "use_for_password_rotation": true,
          "ssh_tunnel_port": 123,
          "source": "string",
          "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": "OK",
          "status_updated": "string",
          "allowed_domains": [
            "string"
          ],
          "service_version": "string",
          "use_legacy_cipher_suites": true,
          "tls_min_version": "string",
          "tls_max_version": "string",
          "browser": "string",
          "db": {
            "protocol": "postgres",
            "tls_certificate_validation": "ENABLED",
            "tls_certificate_trust_anchors": "string",
            "audit_skip_bytes": 123
          },
          "created": "2017-01-01T15:05:05Z",
          "updated": "2017-01-01T15:05:05Z",
          "certificate_template": "string"
        }
      ],
      "principals": [
        {
          "principal": "string",
          "rotate": true,
          "use_user_account": true,
          "passphrase": "string",
          "username_attribute": "string",
          "source": "string",
          "roles": [
            {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            }
          ],
          "applications": [
            {
              "name": "string",
              "application": "string",
              "arguments": "string",
              "working_directory": "string"
            }
          ],
          "service_options": {
            "ssh": {
              "shell": true,
              "file_transfer": true,
              "exec": true,
              "tunnels": true,
              "x11": true,
              "other": true
            },
            "rdp": {
              "file_transfer": true,
              "audio": true,
              "clipboard": true
            },
            "web": {
              "file_transfer": true,
              "audio": true,
              "clipboard": true
            },
            "vnc": {
              "file_transfer": true,
              "clipboard": true
            },
            "db": {
              "max_bytes_download": 123,
              "max_bytes_upload": 123
            }
          },
          "command_restrictions": {
            "enabled": true,
            "default_whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "rshell_variant": "bash",
            "banner": "string",
            "allow_no_match": true,
            "audit_match": true,
            "audit_no_match": true,
            "whitelists": [
              {
                "whitelist": {
                  "id": "5bf77342-221c-11ee-be56-0242ac120002",
                  "name": "string",
                  "deleted": true
                },
                "roles": [
                  {
                    "id": "5bf77342-221c-11ee-be56-0242ac120002",
                    "name": "string"
                  }
                ]
              }
            ]
          }
        }
      ],
      "password_rotation_enabled": true,
      "password_rotation": {
        "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "use_main_account": true,
        "operating_system": "LINUX",
        "winrm_address": "string",
        "winrm_port": 123,
        "protocol": "SSH",
        "certificate_validation_options": "DISABLED",
        "winrm_host_certificate_trust_anchors": "string",
        "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "rotation_status": [
          {
            "principal": "string",
            "last_rotated": "2017-01-01T15:05:05Z",
            "last_error": "2017-01-01T15:05:05Z",
            "last_error_details": "string"
          }
        ],
        "created": "2017-01-01T15:05:05Z",
        "updated": "2017-01-01T15:05:05Z",
        "created_by": "string",
        "updated_by": "string"
      },
      "source_id": "string",
      "cloud_provider": "string",
      "cloud_provider_region": "string",
      "status": [
        {
          "k": "string",
          "v": "string"
        }
      ],
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "distinguished_name": "string",
      "common_name": "string",
      "organization": "string",
      "organizational_unit": "string",
      "zone": "string",
      "scope": [
        "string"
      ],
      "host_type": "string",
      "host_classification": "string",
      "comment": "string",
      "addresses": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "disabled": "BY_ADMIN"
    }
  ]
}

get /host-store/api/v1/hosts

Get hosts

offset

int

Offset from which to start fetching objects

Default: 0

limit

int

Maximum number of objects to return

Default: 50

sortkey

string

Sort by specific object property

Default: "id"

sortdir

string

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

filter

string

Filter hosts - possible values: accessible (filter hosts based on whether the current user has access to them) and configured (list only hosts with services)

Enum: accessible
configured

Response

ExamplesSchema

Successful request, respond with a list of hosts

{
  "count": 123,
  "items": [
    {
      "id": "5bf77342-221c-11ee-be56-0242ac120002",
      "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
      "deployable": true,
      "tofu": true,
      "stand_alone_host": true,
      "external_id": "string",
      "instance_id": "string",
      "audit_enabled": true,
      "session_recording_options": {
        "disable_clipboard_recording": true,
        "disable_file_transfer_recording": true
      },
      "ssh_host_public_keys": [
        {
          "key": "string",
          "fingerprint": "string"
        }
      ],
      "host_certificate_raw": "string",
      "host_certificate": {
        "subject": "string",
        "issuer": "string",
        "serial": "string",
        "not_before": "string",
        "not_after": "string",
        "dns_names": [
          "string"
        ],
        "email_addresses": [
          "string"
        ],
        "ip_addresses": [
          "string"
        ],
        "fingerprint_sha1": "string",
        "fingerprint_sha256": "string"
      },
      "contact_address": "string",
      "services": [
        {
          "service": "SSH",
          "address": "string",
          "port": 123,
          "use_for_password_rotation": true,
          "ssh_tunnel_port": 123,
          "source": "string",
          "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": "OK",
          "status_updated": "string",
          "allowed_domains": [
            "string"
          ],
          "service_version": "string",
          "use_legacy_cipher_suites": true,
          "tls_min_version": "string",
          "tls_max_version": "string",
          "browser": "string",
          "db": {
            "protocol": "postgres",
            "tls_certificate_validation": "ENABLED",
            "tls_certificate_trust_anchors": "string",
            "audit_skip_bytes": 123
          },
          "created": "2017-01-01T15:05:05Z",
          "updated": "2017-01-01T15:05:05Z",
          "certificate_template": "string"
        }
      ],
      "principals": [
        {
          "principal": "string",
          "rotate": true,
          "use_user_account": true,
          "passphrase": "string",
          "username_attribute": "string",
          "source": "string",
          "roles": [
            {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            }
          ],
          "applications": [
            {
              "name": "string",
              "application": "string",
              "arguments": "string",
              "working_directory": "string"
            }
          ],
          "service_options": {
            "ssh": {
              "shell": true,
              "file_transfer": true,
              "exec": true,
              "tunnels": true,
              "x11": true,
              "other": true
            },
            "rdp": {
              "file_transfer": true,
              "audio": true,
              "clipboard": true
            },
            "web": {
              "file_transfer": true,
              "audio": true,
              "clipboard": true
            },
            "vnc": {
              "file_transfer": true,
              "clipboard": true
            },
            "db": {
              "max_bytes_download": 123,
              "max_bytes_upload": 123
            }
          },
          "command_restrictions": {
            "enabled": true,
            "default_whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "rshell_variant": "bash",
            "banner": "string",
            "allow_no_match": true,
            "audit_match": true,
            "audit_no_match": true,
            "whitelists": [
              {
                "whitelist": {
                  "id": "5bf77342-221c-11ee-be56-0242ac120002",
                  "name": "string",
                  "deleted": true
                },
                "roles": [
                  {
                    "id": "5bf77342-221c-11ee-be56-0242ac120002",
                    "name": "string"
                  }
                ]
              }
            ]
          }
        }
      ],
      "password_rotation_enabled": true,
      "password_rotation": {
        "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "use_main_account": true,
        "operating_system": "LINUX",
        "winrm_address": "string",
        "winrm_port": 123,
        "protocol": "SSH",
        "certificate_validation_options": "DISABLED",
        "winrm_host_certificate_trust_anchors": "string",
        "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
        "rotation_status": [
          {
            "principal": "string",
            "last_rotated": "2017-01-01T15:05:05Z",
            "last_error": "2017-01-01T15:05:05Z",
            "last_error_details": "string"
          }
        ],
        "created": "2017-01-01T15:05:05Z",
        "updated": "2017-01-01T15:05:05Z",
        "created_by": "string",
        "updated_by": "string"
      },
      "source_id": "string",
      "cloud_provider": "string",
      "cloud_provider_region": "string",
      "status": [
        {
          "k": "string",
          "v": "string"
        }
      ],
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
      "distinguished_name": "string",
      "common_name": "string",
      "organization": "string",
      "organizational_unit": "string",
      "zone": "string",
      "scope": [
        "string"
      ],
      "host_type": "string",
      "host_classification": "string",
      "comment": "string",
      "addresses": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "disabled": "BY_ADMIN"
    }
  ]
}

post /host-store/api/v1/hosts

Create a host to host store

access_group_id

string

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 (session_recording_options)

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

ssh_host_public_keys

array[object]

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[object]

principals

array[object]

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

password_rotation_enabled

boolean

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

password_rotation

object (password_rotation)

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[string]

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

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[string]

tags

array[string]

disabled

string

Enum: BY_ADMIN
BY_LICENSE

certificate_template

string

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

Request

{
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "deployable": true,
  "tofu": true,
  "stand_alone_host": true,
  "external_id": "string",
  "instance_id": "string",
  "audit_enabled": true,
  "session_recording_options": {
    "disable_clipboard_recording": true,
    "disable_file_transfer_recording": true
  },
  "ssh_host_public_keys": [
    {
      "key": "string"
    }
  ],
  "host_certificate_raw": "string",
  "contact_address": "string",
  "services": [
    {
      "service": "SSH",
      "address": "string",
      "port": 123,
      "use_for_password_rotation": true,
      "db": {
        "protocol": "postgres",
        "tls_certificate_validation": "ENABLED",
        "tls_certificate_trust_anchors": "string",
        "audit_skip_bytes": 123
      },
      "source": "string"
    }
  ],
  "principals": [
    {
      "principal": "string",
      "rotate": true,
      "use_for_password_rotation": true,
      "use_user_account": true,
      "passphrase": "string",
      "source": "string",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002"
        }
      ],
      "applications": [
        {
          "name": "string",
          "application": "string",
          "arguments": "string",
          "working_directory": "string"
        }
      ],
      "service_options": {
        "ssh": {
          "shell": true,
          "file_transfer": true,
          "exec": true,
          "tunnels": true,
          "x11": true,
          "other": true
        },
        "rdp": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "web": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "vnc": {
          "file_transfer": true,
          "clipboard": true
        },
        "db": {
          "max_bytes_download": 123,
          "max_bytes_upload": 123
        }
      },
      "command_restrictions": {
        "enabled": true,
        "default_whitelist": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        },
        "rshell_variant": "bash",
        "banner": "string",
        "allow_no_match": true,
        "audit_match": true,
        "audit_no_match": true,
        "whitelists": [
          {
            "whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "roles": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string"
              }
            ]
          }
        ]
      }
    }
  ],
  "password_rotation_enabled": true,
  "password_rotation": {
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 123,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "rotation_status": [
      {
        "principal": "string",
        "last_rotated": "2017-01-01T15:05:05Z",
        "last_error": "2017-01-01T15:05:05Z",
        "last_error_details": "string"
      }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "source_id": "string",
  "cloud_provider": "string",
  "cloud_provider_region": "string",
  "distinguished_name": "string",
  "common_name": "string",
  "organization": "string",
  "organizational_unit": "string",
  "zone": "string",
  "scope": [
    "string"
  ],
  "host_type": "string",
  "host_classification": "string",
  "comment": "string",
  "addresses": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "disabled": "BY_ADMIN",
  "certificate_template": "string"
}

Response

ExamplesSchema

Host successfully created

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002"
}

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

Resolve service+address to a single host in host store

service

string

required

service type (SSH, RDP, ...)

address

string

required

service address

port

int

required

service port

Request

{
  "service": "string",
  "address": "string",
  "port": 123
}

Response

ExamplesSchema

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

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "deployable": true,
  "tofu": true,
  "stand_alone_host": true,
  "external_id": "string",
  "instance_id": "string",
  "audit_enabled": true,
  "session_recording_options": {
    "disable_clipboard_recording": true,
    "disable_file_transfer_recording": true
  },
  "ssh_host_public_keys": [
    {
      "key": "string",
      "fingerprint": "string"
    }
  ],
  "host_certificate_raw": "string",
  "host_certificate": {
    "subject": "string",
    "issuer": "string",
    "serial": "string",
    "not_before": "string",
    "not_after": "string",
    "dns_names": [
      "string"
    ],
    "email_addresses": [
      "string"
    ],
    "ip_addresses": [
      "string"
    ],
    "fingerprint_sha1": "string",
    "fingerprint_sha256": "string"
  },
  "contact_address": "string",
  "services": [
    {
      "service": "SSH",
      "address": "string",
      "port": 123,
      "use_for_password_rotation": true,
      "ssh_tunnel_port": 123,
      "source": "string",
      "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": "OK",
      "status_updated": "string",
      "allowed_domains": [
        "string"
      ],
      "service_version": "string",
      "use_legacy_cipher_suites": true,
      "tls_min_version": "string",
      "tls_max_version": "string",
      "browser": "string",
      "db": {
        "protocol": "postgres",
        "tls_certificate_validation": "ENABLED",
        "tls_certificate_trust_anchors": "string",
        "audit_skip_bytes": 123
      },
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "certificate_template": "string"
    }
  ],
  "principals": [
    {
      "principal": "string",
      "rotate": true,
      "use_user_account": true,
      "passphrase": "string",
      "username_attribute": "string",
      "source": "string",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        }
      ],
      "applications": [
        {
          "name": "string",
          "application": "string",
          "arguments": "string",
          "working_directory": "string"
        }
      ],
      "service_options": {
        "ssh": {
          "shell": true,
          "file_transfer": true,
          "exec": true,
          "tunnels": true,
          "x11": true,
          "other": true
        },
        "rdp": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "web": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "vnc": {
          "file_transfer": true,
          "clipboard": true
        },
        "db": {
          "max_bytes_download": 123,
          "max_bytes_upload": 123
        }
      },
      "command_restrictions": {
        "enabled": true,
        "default_whitelist": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        },
        "rshell_variant": "bash",
        "banner": "string",
        "allow_no_match": true,
        "audit_match": true,
        "audit_no_match": true,
        "whitelists": [
          {
            "whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "roles": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string"
              }
            ]
          }
        ]
      }
    }
  ],
  "password_rotation_enabled": true,
  "password_rotation": {
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 123,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "rotation_status": [
      {
        "principal": "string",
        "last_rotated": "2017-01-01T15:05:05Z",
        "last_error": "2017-01-01T15:05:05Z",
        "last_error_details": "string"
      }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "source_id": "string",
  "cloud_provider": "string",
  "cloud_provider_region": "string",
  "status": [
    {
      "k": "string",
      "v": "string"
    }
  ],
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "distinguished_name": "string",
  "common_name": "string",
  "organization": "string",
  "organizational_unit": "string",
  "zone": "string",
  "scope": [
    "string"
  ],
  "host_type": "string",
  "host_classification": "string",
  "comment": "string",
  "addresses": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "disabled": "BY_ADMIN"
}

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

Get a single host in host store

host_id

string

uuid

required

Response

ExamplesSchema

Host successfully found

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "deployable": true,
  "tofu": true,
  "stand_alone_host": true,
  "external_id": "string",
  "instance_id": "string",
  "audit_enabled": true,
  "session_recording_options": {
    "disable_clipboard_recording": true,
    "disable_file_transfer_recording": true
  },
  "ssh_host_public_keys": [
    {
      "key": "string",
      "fingerprint": "string"
    }
  ],
  "host_certificate_raw": "string",
  "host_certificate": {
    "subject": "string",
    "issuer": "string",
    "serial": "string",
    "not_before": "string",
    "not_after": "string",
    "dns_names": [
      "string"
    ],
    "email_addresses": [
      "string"
    ],
    "ip_addresses": [
      "string"
    ],
    "fingerprint_sha1": "string",
    "fingerprint_sha256": "string"
  },
  "contact_address": "string",
  "services": [
    {
      "service": "SSH",
      "address": "string",
      "port": 123,
      "use_for_password_rotation": true,
      "ssh_tunnel_port": 123,
      "source": "string",
      "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": "OK",
      "status_updated": "string",
      "allowed_domains": [
        "string"
      ],
      "service_version": "string",
      "use_legacy_cipher_suites": true,
      "tls_min_version": "string",
      "tls_max_version": "string",
      "browser": "string",
      "db": {
        "protocol": "postgres",
        "tls_certificate_validation": "ENABLED",
        "tls_certificate_trust_anchors": "string",
        "audit_skip_bytes": 123
      },
      "created": "2017-01-01T15:05:05Z",
      "updated": "2017-01-01T15:05:05Z",
      "certificate_template": "string"
    }
  ],
  "principals": [
    {
      "principal": "string",
      "rotate": true,
      "use_user_account": true,
      "passphrase": "string",
      "username_attribute": "string",
      "source": "string",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        }
      ],
      "applications": [
        {
          "name": "string",
          "application": "string",
          "arguments": "string",
          "working_directory": "string"
        }
      ],
      "service_options": {
        "ssh": {
          "shell": true,
          "file_transfer": true,
          "exec": true,
          "tunnels": true,
          "x11": true,
          "other": true
        },
        "rdp": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "web": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "vnc": {
          "file_transfer": true,
          "clipboard": true
        },
        "db": {
          "max_bytes_download": 123,
          "max_bytes_upload": 123
        }
      },
      "command_restrictions": {
        "enabled": true,
        "default_whitelist": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        },
        "rshell_variant": "bash",
        "banner": "string",
        "allow_no_match": true,
        "audit_match": true,
        "audit_no_match": true,
        "whitelists": [
          {
            "whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "roles": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string"
              }
            ]
          }
        ]
      }
    }
  ],
  "password_rotation_enabled": true,
  "password_rotation": {
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 123,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "rotation_status": [
      {
        "principal": "string",
        "last_rotated": "2017-01-01T15:05:05Z",
        "last_error": "2017-01-01T15:05:05Z",
        "last_error_details": "string"
      }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "source_id": "string",
  "cloud_provider": "string",
  "cloud_provider_region": "string",
  "status": [
    {
      "k": "string",
      "v": "string"
    }
  ],
  "created": "2017-01-01T15:05:05Z",
  "updated": "2017-01-01T15:05:05Z",
  "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
  "distinguished_name": "string",
  "common_name": "string",
  "organization": "string",
  "organizational_unit": "string",
  "zone": "string",
  "scope": [
    "string"
  ],
  "host_type": "string",
  "host_classification": "string",
  "comment": "string",
  "addresses": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "disabled": "BY_ADMIN"
}

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

Update a single host in host store

access_group_id

string

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 (session_recording_options)

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

ssh_host_public_keys

array[object]

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[object]

principals

array[object]

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

password_rotation_enabled

boolean

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

password_rotation

object (password_rotation)

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[string]

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

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[string]

tags

array[string]

disabled

string

Enum: BY_ADMIN
BY_LICENSE

certificate_template

string

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

Request

{
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "deployable": true,
  "tofu": true,
  "stand_alone_host": true,
  "external_id": "string",
  "instance_id": "string",
  "audit_enabled": true,
  "session_recording_options": {
    "disable_clipboard_recording": true,
    "disable_file_transfer_recording": true
  },
  "ssh_host_public_keys": [
    {
      "key": "string"
    }
  ],
  "host_certificate_raw": "string",
  "contact_address": "string",
  "services": [
    {
      "service": "SSH",
      "address": "string",
      "port": 123,
      "use_for_password_rotation": true,
      "db": {
        "protocol": "postgres",
        "tls_certificate_validation": "ENABLED",
        "tls_certificate_trust_anchors": "string",
        "audit_skip_bytes": 123
      },
      "source": "string"
    }
  ],
  "principals": [
    {
      "principal": "string",
      "rotate": true,
      "use_for_password_rotation": true,
      "use_user_account": true,
      "passphrase": "string",
      "source": "string",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002"
        }
      ],
      "applications": [
        {
          "name": "string",
          "application": "string",
          "arguments": "string",
          "working_directory": "string"
        }
      ],
      "service_options": {
        "ssh": {
          "shell": true,
          "file_transfer": true,
          "exec": true,
          "tunnels": true,
          "x11": true,
          "other": true
        },
        "rdp": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "web": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "vnc": {
          "file_transfer": true,
          "clipboard": true
        },
        "db": {
          "max_bytes_download": 123,
          "max_bytes_upload": 123
        }
      },
      "command_restrictions": {
        "enabled": true,
        "default_whitelist": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        },
        "rshell_variant": "bash",
        "banner": "string",
        "allow_no_match": true,
        "audit_match": true,
        "audit_no_match": true,
        "whitelists": [
          {
            "whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "roles": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string"
              }
            ]
          }
        ]
      }
    }
  ],
  "password_rotation_enabled": true,
  "password_rotation": {
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 123,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "rotation_status": [
      {
        "principal": "string",
        "last_rotated": "2017-01-01T15:05:05Z",
        "last_error": "2017-01-01T15:05:05Z",
        "last_error_details": "string"
      }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "source_id": "string",
  "cloud_provider": "string",
  "cloud_provider_region": "string",
  "distinguished_name": "string",
  "common_name": "string",
  "organization": "string",
  "organizational_unit": "string",
  "zone": "string",
  "scope": [
    "string"
  ],
  "host_type": "string",
  "host_classification": "string",
  "comment": "string",
  "addresses": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "disabled": "BY_ADMIN",
  "certificate_template": "string"
}

Response

ExamplesSchema

Host successfully updated

Empty response

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

Delete a single host from the host store

host_id

string

uuid

required

Response

ExamplesSchema

Host successfully deleted

Empty response

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

Create, update a host in host store

access_group_id

string

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 (session_recording_options)

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

ssh_host_public_keys

array[object]

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[object]

principals

array[object]

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

password_rotation_enabled

boolean

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

password_rotation

object (password_rotation)

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[string]

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

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[string]

tags

array[string]

disabled

string

Enum: BY_ADMIN
BY_LICENSE

certificate_template

string

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

Request

{
  "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
  "deployable": true,
  "tofu": true,
  "stand_alone_host": true,
  "external_id": "string",
  "instance_id": "string",
  "audit_enabled": true,
  "session_recording_options": {
    "disable_clipboard_recording": true,
    "disable_file_transfer_recording": true
  },
  "ssh_host_public_keys": [
    {
      "key": "string"
    }
  ],
  "host_certificate_raw": "string",
  "contact_address": "string",
  "services": [
    {
      "service": "SSH",
      "address": "string",
      "port": 123,
      "use_for_password_rotation": true,
      "db": {
        "protocol": "postgres",
        "tls_certificate_validation": "ENABLED",
        "tls_certificate_trust_anchors": "string",
        "audit_skip_bytes": 123
      },
      "source": "string"
    }
  ],
  "principals": [
    {
      "principal": "string",
      "rotate": true,
      "use_for_password_rotation": true,
      "use_user_account": true,
      "passphrase": "string",
      "source": "string",
      "roles": [
        {
          "id": "5bf77342-221c-11ee-be56-0242ac120002"
        }
      ],
      "applications": [
        {
          "name": "string",
          "application": "string",
          "arguments": "string",
          "working_directory": "string"
        }
      ],
      "service_options": {
        "ssh": {
          "shell": true,
          "file_transfer": true,
          "exec": true,
          "tunnels": true,
          "x11": true,
          "other": true
        },
        "rdp": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "web": {
          "file_transfer": true,
          "audio": true,
          "clipboard": true
        },
        "vnc": {
          "file_transfer": true,
          "clipboard": true
        },
        "db": {
          "max_bytes_download": 123,
          "max_bytes_upload": 123
        }
      },
      "command_restrictions": {
        "enabled": true,
        "default_whitelist": {
          "id": "5bf77342-221c-11ee-be56-0242ac120002",
          "name": "string",
          "deleted": true
        },
        "rshell_variant": "bash",
        "banner": "string",
        "allow_no_match": true,
        "audit_match": true,
        "audit_no_match": true,
        "whitelists": [
          {
            "whitelist": {
              "id": "5bf77342-221c-11ee-be56-0242ac120002",
              "name": "string",
              "deleted": true
            },
            "roles": [
              {
                "id": "5bf77342-221c-11ee-be56-0242ac120002",
                "name": "string"
              }
            ]
          }
        ]
      }
    }
  ],
  "password_rotation_enabled": true,
  "password_rotation": {
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 123,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "rotation_status": [
      {
        "principal": "string",
        "last_rotated": "2017-01-01T15:05:05Z",
        "last_error": "2017-01-01T15:05:05Z",
        "last_error_details": "string"
      }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "source_id": "string",
  "cloud_provider": "string",
  "cloud_provider_region": "string",
  "distinguished_name": "string",
  "common_name": "string",
  "organization": "string",
  "organizational_unit": "string",
  "zone": "string",
  "scope": [
    "string"
  ],
  "host_type": "string",
  "host_classification": "string",
  "comment": "string",
  "addresses": [
    "string"
  ],
  "tags": [
    "string"
  ],
  "disabled": "BY_ADMIN",
  "certificate_template": "string"
}

Response

ExamplesSchema

Operation okay

{
  "id": "5bf77342-221c-11ee-be56-0242ac120002",
  "action": "CREATED"
}

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

Set a host to be depoyable or undeployable.

deployable

boolean

Request

{
  "deployable": true
}

Response

ExamplesSchema

Host successfully updated

Empty response

get /host-store/api/v1/hosts/tags

Get list of host's tags.

offset

int

Offset from which to start fetching objects

Default: 0

limit

int

Maximum number of objects to return

Default: 50

sortdir

string

Sort direction, asc or desc

Default: "ASC"
Enum: ASC
DESC

query

string

Query string matches the tags

Response

ExamplesSchema

Received list of host's tags

[
  "string"
]

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

Enable/disable host.

disabled

boolean

Request

{
  "disabled": true
}

Response

ExamplesSchema

Host enabled/disabled successfully

Empty response