Skip to content

JSON API

jack edited this page Jun 25, 2026 · 3 revisions

Wawel Auth can expose a small public JSON API for the bundled landing page and other external tools.

This endpoint is controlled by:

  • enablePublicInfoApi
  • publicInfoApiPath

If publicInfoApiPath is relative, it is resolved under publicPagePath.

If publicInfoApiPath is empty, the endpoint is disabled.

What it is for

This is a public, read-only status endpoint.

It is used by the bundled public website to display:

  • Server name and description
  • MOTD and player count
  • Advertised join address
  • Registration policy
  • Auth API root
  • Fallback providers
  • Connected players
  • Installed mods
  • Server icon URLs

Response format

The response is JSON and currently includes these top-level fields:

  • apiVersion
  • generatedAt
  • cacheTtlSeconds
  • branding
  • server
  • links
  • icons
  • modlist

Nested fields:

  • server.name
  • server.description
  • server.motd
  • server.playersOnline
  • server.maxPlayers
  • server.connectedPlayers
  • server.address
  • server.addressWarning (present when the advertised join address needs admin attention)
  • server.registration
  • server.fallbacks
  • links.apiRoot
  • links.homepage
  • links.register
  • links.admin
  • links.dynmap
  • links.publicPagePath
  • links.publicInfoApiPath
  • links.authlibInjectorHeader
  • icons.hasStatic
  • icons.hasAnimated
  • icons.staticUrl (static server icon)
  • icons.animatedUrl (animated server icon, if provided by FentLib)
  • icons.preferred (animated, static, or fallback)

server.connectedPlayers includes public avatar URLs generated by Wawel Auth.

Clone this wiki locally