---
title: "Get Host"
method: GET
path: "/api/host/{host_id}"
tags: ["Host"]
---

# Get Host

`GET /api/host/{host_id}`

get host by **id**

## Path parameters

- `host_id` integer, required

## Response `200`

Successful Response

- BaseHost
  - `id` integer, nullable
  - `remark` string, required
  - `address` string[]
  - `inbound_tag` string, nullable
  - `port` integer, nullable
  - `sni` string[], nullable
  - `host` string[], nullable
  - `path` string, nullable
  - `security` 'inbound_default' | 'none' | 'tls'
  - `alpn` ProxyHostALPN[], nullable
  - `fingerprint` '' | 'chrome' | 'firefox' | 'safari' | 'ios' | 'android' | 'edge' | '360' | 'qq' | 'random' | 'randomized' | 'randomizednoalpn' | 'unsafe'
  - `allowinsecure` boolean, nullable
  - `is_disabled` boolean
  - `http_headers` object, nullable
  - `transport_settings` TransportSettingsOutput
    - `xhttp_settings` XHttpSettingsOutput
      - `mode` 'auto' | 'packet-up' | 'stream-up' | 'stream-one'
      - `no_grpc_header` boolean, nullable
      - `x_padding_bytes` string, nullable
      - `x_padding_obfs_mode` boolean, nullable
      - `x_padding_key` string, nullable
      - `x_padding_header` string, nullable
      - `x_padding_placement` string, nullable
      - `x_padding_method` string, nullable
      - `uplink_http_method` string, nullable
      - `session_placement` string, nullable
      - `session_key` string, nullable
      - `seq_placement` string, nullable
      - `seq_key` string, nullable
      - `uplink_data_placement` string, nullable
      - `uplink_data_key` string, nullable
      - `uplink_chunk_size` string, nullable
      - `sc_max_each_post_bytes` string, nullable
      - `sc_min_posts_interval_ms` string, nullable
      - `xmux` XMuxSettingsOutput
        - `maxConcurrency` string, nullable
        - `maxConnections` string, nullable
        - `cMaxReuseTimes` string, nullable
        - `hMaxReusableSecs` string, nullable
        - `hMaxRequestTimes` string, nullable
        - `hKeepAlivePeriod` integer, nullable
      - `download_settings` integer, nullable
    - `grpc_settings` GRPCSettings
      - `multi_mode` boolean
      - `idle_timeout` integer, nullable
      - `health_check_timeout` integer, nullable
      - `permit_without_stream` boolean
      - `initial_windows_size` integer, nullable
    - `kcp_settings` KCPSettings
      - `mtu` integer, nullable
      - `tti` integer, nullable
      - `uplink_capacity` integer, nullable
      - `downlink_capacity` integer, nullable
      - `congestion` boolean, nullable
      - `read_buffer_size` integer, nullable
      - `write_buffer_size` integer, nullable
    - `tcp_settings` TcpSettings
      - `header` string
      - `request` HTTPRequest
        - `version` string
        - `headers` object, nullable
        - `method` string
      - `response` HTTPResponse
        - `version` string
        - `headers` object, nullable
        - `status` string
        - `reason` string
    - `websocket_settings` WebSocketSettings
      - `heartbeatPeriod` integer, nullable
  - `mux_settings` MuxSettingsOutput
    - `sing_box` SingBoxMuxSettings
      - `enable` boolean
      - `protocol` 'smux' | 'yamux' | 'h2mux'
      - `max_connections` integer, nullable
      - `max_streams` integer, nullable
      - `min_streams` integer, nullable
      - `padding` boolean
      - `brutal` Brutal
        - `enable` boolean
        - `up_mbps` integer, required
        - `down_mbps` integer, required
    - `clash` ClashMuxSettings
      - `enable` boolean
      - `protocol` 'smux' | 'yamux' | 'h2mux'
      - `max_connections` integer, nullable
      - `max_streams` integer, nullable
      - `min_streams` integer, nullable
      - `padding` boolean
      - `brutal` Brutal
        - `enable` boolean
        - `up_mbps` integer, required
        - `down_mbps` integer, required
      - `statistic` boolean
      - `only_tcp` boolean
    - `xray` XrayMuxSettingsOutput
      - `enabled` boolean
      - `concurrency` integer, nullable
      - `xudpConcurrency` integer, nullable
      - `xudpProxyUDP443` 'reject' | 'allow' | 'skip'
  - `fragment_settings` FragmentSettings
    - `xray` XrayFragmentSettings
      - `packets` string, required
      - `length` string, required
      - `interval` string, required
    - `sing_box` SingBoxFragmentSettings
      - `fragment` boolean
      - `fragment_fallback_delay` string
      - `record_fragment` boolean
  - `noise_settings` NoiseSettings
    - `xray` XrayNoiseSettings[], nullable
      - `type` string, required
      - `packet` string, required
      - `delay` string, required
      - `apply_to` string
      - `rand_range` string, nullable
  - `random_user_agent` boolean
  - `use_sni_as_host` boolean
  - `vless_route` string, nullable
  - `priority` integer, required
  - `status` UserStatus[], nullable
  - `ech_config_list` string, nullable
  - `ech_query_strategy` 'none' | 'half' | 'full'
  - `pinned_peer_cert_sha256` string, nullable
  - `verify_peer_cert_by_name` string[], nullable
  - `wireguard_overrides` WireGuardHostOverrides — Optional per-host values merged into WireGuard subscription output.
    - `allowed_ips` string[], nullable
    - `mtu` integer, nullable
    - `reserved` string, nullable
    - `keepalive_seconds` integer, nullable
    - `dns` string[], nullable
  - `subscription_templates` SubscriptionTemplates
    - `xray` integer, nullable

## Other responses

- `401` — Unauthorized Error
- `403` — Forbidden Error
- `422` — Validation Error

---

[API](https://skmtc.dev/rain/apis/pasarguardapi.md) · [All operations](https://skmtc.dev/rain/apis/pasarguardapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rain/pasarguardapi/revisions/b3bebca20611/schema)