api.sites

The site domain

api.sites gives you information about your sites. It's the smallest domain — just 3 functions — but essential for multi-site dashboards and admin panels.

Function reference

Current site

The most commonly used function — read your site's metadata:

local site = api.sites.current()
print(site.name)    -- "mysite"
print(site.id)      -- 18448
print(site.type)    -- 2 (Lua engine)

Building a site switcher

For users who manage multiple sites:

app:get("/dashboard", function(ctx)
    local sites = api.sites.list()
    local current = api.sites.current()

    return ctx:render("dashboard", {
        sites = sites.items,
        current_site = current,
        site_count = sites.total
    })
end)

Site fields

Each site object includes these fields:

Practical use: site info in layouts

app:on("before", function(ctx)
    ctx.site = api.sites.current()
end)

app:get("/", function(ctx)
    return ctx:render("home", {
        site_name = ctx.site.name,
        site_id = ctx.site.id
    })
end)

Next: api.forums — discussion boards.