foyr.json

An optional file at the root of your repo. Without it, Foyr uses safe defaults: private app, health check on /api/health.

foyr.json

{
  "access": "private",
  "healthCheck": "/api/health",
  "permissions": {
    "reports:export": "member",
    "billing:edit": "admin"
  }
}

Fields

Field	Type	Default	What it does
`access`	`"private"` or `"public"`	`"private"`	Who can open the app. See access modes.
`healthCheck`	path	`"/api/health"`, then `"/"`	Route that must return `2xx` before a new version goes live.
`permissions`	object	`{}`	Action name → minimum role, used by `hasPermission`.

Settings in the dashboard override foyr.json until the next deploy that changes the file.

Permission names

Use any string; resource:verb reads well. Roles are owner, admin, member and viewer, each including the ones after it. Actions not listed require admin.

PreviousPython SDK NextArchitecture

Last updated 26 Sep 2026