k.site

Versioned site resources for the current site: pages, layouts, views, scripts, styles, codes, and menus.

Overview

k.site is the unified entry point for structured resources stored in the current site. Use its submodules to create, update, delete, and inspect pages, layouts, views, scripts, styles, code resources, and menus.

Difference from k.file and the CMS file library

• k.site manages structured site resources with versioning and routing.
• k.file reads and writes ordinary files in the site directory. See k.file.
• k.site.files manages versioned resources in the CMS file library. It is separate from ordinary site-directory files exposed by k.file.

Submodule Navigation

Member	Doc
k.site.pages	page.md
k.site.layouts	layout.md
k.site.views	view.md
k.site.scripts	js.md
k.site.styles	css.md
k.site.codes	code.md — API and CodeBlock resources (codeType)
k.site.menus	menu.md — frontend navigation menus
k.site.runJob	job.md — manually trigger scheduled jobs

Commonly Used Methods

list()

Lists sites accessible to the current signed-in user. This is mainly useful in multi-site automation scenarios. The method requires user and current-organization context and may return null when that context is unavailable.

Parameters: None.

Returns: SiteSummaryViewModel[] | null.

k.api.get("sites", () => {
    return k.site.list() || []
})

diskSpace

Queries the storage used by the site, for example k.site.diskSpace.getSiteSize().

k.api.get("siteSize", () => {
    return k.site.diskSpace.getSiteSize()
})

Related Docs

• Template Engine — how Layout, Page, and View resources are referenced in HTML
• k.page — Metadata of the currently rendered page (k.page.setTitle, etc.)
• k.module — script module context
• k.label — Multilingual k.t / k.label
• Admin: Files — CMS file library (not k.file)