> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zonely.gen.tr/llms.txt
> Use this file to discover all available pages before exploring further.

# Hytale WebServer and Query

> Make Hytale server information queryable via WebServer.

WebServer opens web service in Hytale; Query offers server name, version and player information from this service. Two plugins for Query should also be installed.

## Install Add-ons

[Nitrado WebServer](https://github.com/nitrado/hytale-plugin-webserver/releases) and [Nitrado Query](https://github.com/nitrado/hytale-plugin-query/releases) files **mods/** Place it in the folder. Check the two plugins are installed on the start records.

## Prepare web port

The default web port is three more of the game port. For example game port **5520** web port **5523** . Custom settings **mods/Nitrado\_WebServer/config.json** is in the file.

```json title="Example restricted to a reverse proxy on the same machine" theme={"theme":"css-variables"}
{
  "BindHost": "127.0.0.1",
  "BindPort": 5523
}
```

This example uses local listening address for reverse proxy in the same machine. Prepare the external access layout and TCP port according to your own hosting. WebServer uses TLS; the client’s trust will be certified or reversed [admin guide](https://github.com/nitrado/hytale-plugin-webserver/blob/main/docs/admin/admin-guide.md) Configure according to.

## Prepare Query request

```http title="API request format" theme={"theme":"css-variables"}
GET /Nitrado/Query HTTP/1.1
Accept: application/x.hytale.nitrado.query+json;version=1
```

Home **/Nitrado/Query** in shape. Use the JSON Accept header released on the API client. The browser can display HTML view at the same address.

## Select the information to view

**permissions.json** inside **Groups.ANONYMOUS** for basic appearance **nitrado.query.web.read.basic** The permission can be added. The player has separate permissions of the plugin and other details; open the information you will offer alone.

Check the permissions in the response of 401/403, the Accept header in 406, TLS and TCP access in connection failure.

[Query API](https://github.com/nitrado/hytale-plugin-query#api-endpoints) · [Command connection](https://docs.zonely.gen.tr/en/integrations/hytale.md) · [Connections and tools](https://docs.zonely.gen.tr/en/integrations/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.