apps
github

Set the Root Directory

Set the platform Root Directory: the subdirectory of the repository the build runs from. Takes precedence over the repo's faable.json rootDir; null clears it and hands precedence back. The path must exist on the deploy branch.

post/app/{id}/root-dir

Request

  • Base URL: https://api.faable.com
  • URL: https://api.faable.com/app/{id}/root-dir
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://faable.auth.faable.link/authorize, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://faable.auth.faable.link/oauth/token)
    • HTTP bearer
    • HTTP basic
    • API key in query parameter apikey

Path parameters

idstring required

Request body

root_dirstring required

Response

App

idstring required

App ID

teamstring required
namestring required
descriptionstring required
slugstring required
urlstring required
activeboolean required
disabled_reasonstring

Reason the app was administratively disabled. Null when the app is active.

runtime'node' | 'php' | 'python' required
runtime_strategystring required
mode'standard' | 'coexistence' required
build_mode'local' | 'remote'
deploy_output'image' | 'artifact'
root_dirstring
gitlab_ci_project_idstring
gitlab_project_idstring
gitlab_project_pathstring
gitlab_branchstring
coexistence_routing'cookie' | 'path'
coexistence_keep_versionsnumber

K: how many versions stay live under mode=coexistence (active + K-1 draining)

coexistence_drain_hoursnumber

Max hours a demoted version keeps serving pinned sessions before GC

instancestring

Compute catalogue row the app runs on (computeinstance id). Replaces instance_type.

instance_typestring required

Faable instance types comprise varying combinations of CPU, memory, storage, and networking capacity. Name of instance; kept for existing clients.

region'gui1' | 'poz1' | 'ams1' required

High-level summary of where the Database is in its lifecycle

notify_deploy_successboolean

Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this.

http3boolean

Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it.

repositorystring
github_branchstring
github_installation_idstring
github_installation_statestring

Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked.

github_repo_hiddenstring

The linked repository stopped being readable after the app was created, per the GitHub repository webhook. Absent/null = visible; 'deleted' | 'privatized' | 'archived' = the source was pulled after deploying (the analyzer re-scores the promoted deployment against our own build artifact).

github_disconnect_reasonstring

Why the platform cleared the repository link automatically. Absent/null = never auto-disconnected (or re-linked since); 'push_flood' = the repo exceeded the hourly push limit and must be re-linked by the user.

deploy_triggerstring

Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4).

deploy_gatestring

Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green.

metadataobject required
createdAtstring required

App creation date

updatedAtstring

App updated date

Changes

No recorded changes to this operation across all 1 revision of this API.