Skip to main content
POST
Plan Deploy

Authorizations

Authorization
string
header
required

A floo_ API key.

Headers

X-Floo-Org-Id
string<uuid>

Organization to act in; defaults to the one joined most recently.

Body

application/json

What the caller knows locally. Nothing here is stored.

app
string
required

The app name from floo.app.toml.

Required string length: 2 - 40
Pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
remotes
Remotes · object

git remote names and URLs. Only the host and owner/repo are read.

remote
string | null

The remote the current branch tracks.

branch
string | null
Maximum string length: 255
head
string | null

The full HEAD commit (git rev-parse HEAD). Leave it out when there is no git folder, as in a chat.

Pattern: ^[0-9a-f]{40}$
source
enum<string> | null

The caller's choice when the folder has no remote.

Available options:
github,
floo

Response

Successful Response

The answer. ok false is a stop: nothing was created and next holds the fix.

ok
boolean
required
app
string
required
org
string
required
message
string
required
decision
enum<string> | null

What the caller does next when the plan is ok.

Available options:
push,
connect_github,
create_github_repo,
create_hosted
code
enum<string> | null

Why a plan stopped. Callers branch on these, so the set is closed.

Available options:
APP_NAME_TAKEN,
APP_HAS_NO_SOURCE,
REPO_MISMATCH,
SOURCE_CHOICE_REQUIRED,
REMOTE_NOT_GITHUB,
GITHUB_APP_NOT_INSTALLED,
GITHUB_REPO_NOT_IN_INSTALLATION,
GITHUB_REPO_NOT_ACCESSIBLE,
ORG_MEMBERSHIP_REQUIRED
source
PlanSource · object | null

The source the app deploys from, or will once the plan is carried out.

access_mode
enum<string> | null

Who can open the dev URL, now or once the plan is carried out. accounts: only the org's signed-in members, so a request without a floo sign-in gets 401. public: anyone with the link. [app] access_mode in floo.app.toml replaces it on the next push.

Available options:
public,
password,
accounts,
sso
next
NextStep · object[]

The first entry is recommended. Several entries are choices for the user.

suggested_names
string[]
warnings
string[]