Skip to main content
POST
Create a host

Authorizations

Authorization
string
header
required

An API key minted in Command Center (Settings -> API Keys), sent as Authorization: Bearer 2501_ak_.... A Command Center session cookie is also accepted.

Body

application/json
org_id
string
required
name
string
required
Required string length: 1 - 255
public_ip
string | null
private_ip
string | null
ip_connect_mode
enum<string>
default:auto
Available options:
auto,
public,
private
additional_names
string[]
Required string length: 1 - 255
target_type
enum<string>
default:ssh
Available options:
ssh,
winrm
target_port
integer | null
Required range: 1 <= x <= 65535
skip_tls_verify
boolean
default:false
knowledge
string | null
tags
string[]
jump_host_ids
string[]
Maximum array length: 5
is_jump_host
boolean
default:false
jump_host_username_credential_id
string | null
jump_host_secret_credential_id
string | null
eligible_subnets
string[]
Maximum array length: 64

Response

The created host

id
string
required
Example:

"hst_8272f9b4-3c1e-4a2b-9f0d-1e2c3b4a5d6e"

name
string
required
Example:

"web-01"

org_id
string
required
Example:

"org_460b541c-..."

tenant_id
string
required
Example:

"ten_115bea44-..."

public_ip
string | null
required
private_ip
string | null
required
Example:

"10.0.4.12"

ip_connect_mode
enum<string>
required
Available options:
auto,
public,
private
target_type
enum<string>
required
Available options:
ssh,
winrm
target_port
integer | null
required
skip_tls_verify
boolean
required
additional_names
string[]
required
tags
string[]
required
Example:
knowledge
string | null
required
is_jump_host
boolean
required
jump_host_ids
string[]
required
jump_host_username_credential_id
string | null
required
jump_host_secret_credential_id
string | null
required
eligible_subnets
string[]
required
created_at
string<date-time>
required
Example:

"2026-08-26T10:00:26.380Z"

updated_at
string<date-time>
required
Example:

"2026-08-26T10:00:26.380Z"

unique_id
string | null
external_id
string | null
mac
string | null
enrichment_source
string | null