HTTP config

The OpenAPI 3.1 document is generated beside this preview as openapi.json. Schemas document current behavior; they never validate runtime requests. The built-in server is loopback/host-guarded and has no authentication.

getProjectConfig

Read project configuration

getProjectConfig description

Loads the project's roku-config.ts and returns its default export (or the module itself when it has no default export) as JSON, with secret-shaped keys and function values removed. An omitted or blank root uses the server's project root; a nonblank root must be an absolute path inside an allowed project base, or the route answers 403 PATH_VALIDATION_ERROR. Without config the route walks upward from root looking for roku-config.ts and answers 404 CONFIG_NOT_FOUND when none exists. An explicit config is resolved against root, must exist, must end in .ts, .js, .cjs or .mjs, and must stay inside root; otherwise the route answers 400. A repeated root or config query key answers 400 VALIDATION_ERROR, a config that fails to load with an rk error answers 400 with that error's code, and any other load failure, such as a syntax error, answers 500 CONFIG_ERROR. The file is returned as loaded, without merging defaults or a dev config. The config shape varies by project, so the success schema is open.

getProjectConfig contract

GET /api/config

Responses: 200, 400, 403, 404, 500; middleware can also return 403, 408 or 429.

getProjectConfig see also

• MCP get_roku_config

getProjectConfig query.root

Absolute project root inside an allowed project base; omitted or blank uses the server's project root.

getProjectConfig query.config

Config file path resolved against root; omitted or blank searches upward from root for roku-config.ts.