---
title: "Get Hosts"
method: GET
path: "/api/hosts"
tags: ["Host"]
---

# Get Hosts

`GET /api/hosts`

Get proxy hosts.

## Query parameters

- `ids` integer[], nullable
- `offset` integer
- `limit` integer

## 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` TransportSettings
    - `xhttp_settings` XHttpSettings
      - `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
      - `session_id_table` string, nullable
      - `session_id_length` 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` XMuxSettings
        - `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
      - `maxSplit` string, nullable
    - `sing_box` SingBoxFragmentSettings
      - `fragment` boolean
      - `fragment_fallback_delay` string
      - `record_fragment` boolean
  - `noise_settings` NoiseSettings
    - `xray` XrayNoiseSettings[], nullable
      - `type` string, required
      - `packet` union
        - string
        - integer[]
      - `delay` union
        - string
        - integer
      - `apply_to` string
      - `rand` union
        - integer
        - string
      - `randRange` 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
  - `final_mask_settings` FinalMask
    - `tcp` FinalMaskTcpLayer[], nullable
      - `type` 'header-custom' | 'fragment' | 'sudoku' | 'xmc', required
      - `settings` union
        - FinalMaskTcpHeaderCustomSettings
          - `clients` array[], nullable
            - XrayNoiseSettings[]
              - …
          - `servers` array[], nullable
            - XrayNoiseSettings[]
              - …
          - `errors` array[], nullable
            - XrayNoiseSettings[]
              - …
        - FinalMaskFragmentSettings
          - `packets` string, nullable
          - `lengths` union[], nullable
            - union
              - …
          - `delays` union[], nullable
            - union
              - …
          - `maxSplit` union
            - string
            - integer
        - FinalMaskSudokuSettings
          - `password` string, nullable
          - `ascii` string, nullable
          - `customTable` string, nullable
          - `customTables` string[], nullable
          - `paddingMin` integer, nullable
          - `paddingMax` integer, nullable
        - FinalMaskXmcSettings
          - `hostname` string, nullable
          - `password` string, nullable
          - `profiles` FinalMaskXmcProfile[], nullable
            - `username` string, required
            - `uuid` string, required
            - `texturesValue` string, required
            - `texturesSignature` string, required
          - `usernames` string[], nullable
        - object
    - `udp` FinalMaskUdpLayer[], nullable
      - `type` 'header-custom' | 'mkcp-legacy' | 'noise' | 'salamander' | 'sudoku' | 'xdns' | 'xicmp' | 'realm' | 'header-dns' | 'header-dtls' | 'header-srtp' | 'header-utp' | 'header-wechat' | 'header-wireguard' | 'mkcp-original' | 'mkcp-aes128gcm', required
      - `settings` union
        - FinalMaskUdpHeaderCustomSettings
          - `client` XrayNoiseSettings[], nullable
            - `type` string, required
            - `packet` union
              - …
            - `delay` union
              - …
            - `apply_to` string
            - `rand` union
              - …
            - `randRange` string, nullable
          - `server` XrayNoiseSettings[], nullable
            - `type` string, required
            - `packet` union
              - …
            - `delay` union
              - …
            - `apply_to` string
            - `rand` union
              - …
            - `randRange` string, nullable
        - FinalMaskPasswordSettings
          - `password` string, nullable
        - FinalMaskSudokuSettings
          - `password` string, nullable
          - `ascii` string, nullable
          - `customTable` string, nullable
          - `customTables` string[], nullable
          - `paddingMin` integer, nullable
          - `paddingMax` integer, nullable
        - FinalMaskDomainSettings
          - `domain` string, nullable
        - FinalMaskXdnsSettings
          - `domains` string[], nullable
          - `resolvers` string[], nullable
          - `domain` string, nullable
        - FinalMaskXicmpSettings
          - `dgram` boolean, nullable
          - `ips` string[], nullable
          - `listenIp` string, nullable
          - `id` integer, nullable
        - FinalMaskNoiseSettings
          - `reset` union
            - string
            - integer
          - `noise` XrayNoiseSettings[], nullable
            - `type` string, required
            - `packet` union
              - …
            - `delay` union
              - …
            - `apply_to` string
            - `rand` union
              - …
            - `randRange` string, nullable
        - FinalMaskSalamanderSettings
          - `password` string, nullable
          - `packetSize` unknown
        - FinalMaskRealmSettings
          - `url` string, nullable
          - `stunServers` string[], nullable
          - `tlsConfig` object, nullable
        - FinalMaskMkcpLegacySettings
          - `header` string, nullable
          - `value` string, nullable
        - object
    - `quicParams` FinalMaskQuicParams
      - `congestion` 'reno' | 'bbr' | 'brutal' | 'force-brutal'
      - `debug` boolean, nullable
      - `bbrProfile` string, nullable
      - `brutalUp` union
        - string
        - integer
        - number
      - `brutalDown` union
        - string
        - integer
        - number
      - `udpHop` FinalMaskUdpHop
        - `ports` string, nullable
        - `interval` union
          - string
          - integer
      - `initStreamReceiveWindow` integer, nullable
      - `maxStreamReceiveWindow` integer, nullable
      - `initConnectionReceiveWindow` integer, nullable
      - `maxConnectionReceiveWindow` integer, nullable
      - `maxIdleTimeout` integer, nullable
      - `keepAlivePeriod` integer, nullable
      - `disablePathMTUDiscovery` boolean, nullable
      - `maxIncomingStreams` integer, nullable

## Other responses

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

---

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