Skip to main content

Local-only UDP API

Local-only UDP API

In addition to the above HTTP-based API, it is also possible to access the API from the local machine on UDP port 4242 on the "localhost" address. Whether that is IPv4 or IPv6 localhost is dependent on your operating system default address family, so preferably connect to the hostname "localhost" verbatim to prevent issues.

All regular API requests are supported, and must be sent to port 4242 over UDP. The payload is the raw JSON object with the request(s).

This API endpoint will reply with a UDP packet to the same address and port it received requests from, containing a JSON object with the response. The minimal flag is set automatically for UDP API requests.

This endpoint is particularly useful when combined with the api_endpoint API call.