> ## Documentation Index
> Fetch the complete documentation index at: https://getfloo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Plan Deploy

> Say which source this deploy uses, why, and what to run next.

Read-only. `ok` false is a stop: nothing was created, no name was claimed,
and `next` holds the fix, or is empty when the fix is outside floo's API (an
org invite). Several `next` entries are choices for the user.



## OpenAPI

````yaml https://api.getfloo.com/openapi.json post /v1/deploy/plan
openapi: 3.1.0
info:
  title: floo API
  version: 0.1.0
servers:
  - url: https://api.getfloo.com
security: []
paths:
  /v1/deploy/plan:
    post:
      tags:
        - deploy
      summary: Plan Deploy
      description: >-
        Say which source this deploy uses, why, and what to run next.


        Read-only. `ok` false is a stop: nothing was created, no name was
        claimed,

        and `next` holds the fix, or is empty when the fix is outside floo's API
        (an

        org invite). Several `next` entries are choices for the user.
      operationId: deploy_plan_deploy
      parameters:
        - $ref: '#/components/parameters/X-Floo-Org-Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployPlanRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployPlan'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    X-Floo-Org-Id:
      name: X-Floo-Org-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Organization to act in; defaults to the one joined most recently.
  schemas:
    DeployPlanRequest:
      properties:
        app:
          type: string
          maxLength: 40
          minLength: 2
          pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
          title: App
          description: The app name from floo.app.toml.
        remotes:
          additionalProperties:
            type: string
          type: object
          maxProperties: 20
          title: Remotes
          description: git remote names and URLs. Only the host and owner/repo are read.
        remote:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote
          description: The remote the current branch tracks.
        branch:
          anyOf:
            - type: string
              maxLength: 255
            - type: 'null'
          title: Branch
        head:
          anyOf:
            - type: string
              pattern: ^[0-9a-f]{40}$
            - type: 'null'
          title: Head
          description: >-
            The full HEAD commit (`git rev-parse HEAD`). Leave it out when there
            is no git folder, as in a chat.
        source:
          anyOf:
            - $ref: '#/components/schemas/SourceKind'
            - type: 'null'
          description: The caller's choice when the folder has no remote.
      additionalProperties: false
      type: object
      required:
        - app
      title: DeployPlanRequest
      description: What the caller knows locally. Nothing here is stored.
    DeployPlan:
      properties:
        ok:
          type: boolean
          title: Ok
        app:
          type: string
          title: App
        org:
          type: string
          title: Org
        decision:
          anyOf:
            - $ref: '#/components/schemas/DeployDecision'
            - type: 'null'
        code:
          anyOf:
            - $ref: '#/components/schemas/PlanStop'
            - type: 'null'
        message:
          type: string
          title: Message
        source:
          anyOf:
            - $ref: '#/components/schemas/PlanSource'
            - type: 'null'
        access_mode:
          anyOf:
            - $ref: '#/components/schemas/AccessMode'
            - type: 'null'
          description: >-
            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.
        next:
          items:
            $ref: '#/components/schemas/NextStep'
          type: array
          title: Next
          description: >-
            The first entry is recommended. Several entries are choices for the
            user.
        suggested_names:
          items:
            type: string
          type: array
          title: Suggested Names
        warnings:
          items:
            type: string
          type: array
          title: Warnings
      type: object
      required:
        - ok
        - app
        - org
        - message
      title: DeployPlan
      description: >-
        The answer. `ok` false is a stop: nothing was created and `next` holds
        the fix.
    ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Body of every error response except request validation (422).
    SourceKind:
      type: string
      enum:
        - github
        - floo
      title: SourceKind
      description: Where an app's code lives.
    DeployDecision:
      type: string
      enum:
        - push
        - connect_github
        - create_github_repo
        - create_hosted
      title: DeployDecision
      description: What the caller does next when the plan is ok.
    PlanStop:
      type: string
      enum:
        - 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
      title: PlanStop
      description: Why a plan stopped. Callers branch on these, so the set is closed.
    PlanSource:
      properties:
        kind:
          $ref: '#/components/schemas/SourceKind'
        repo:
          anyOf:
            - type: string
            - type: 'null'
          title: Repo
        branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch
      type: object
      required:
        - kind
      title: PlanSource
      description: The source the app deploys from, or will once the plan is carried out.
    AccessMode:
      type: string
      enum:
        - public
        - password
        - accounts
        - sso
      title: AccessMode
      description: Access control mode for an app.
    NextStep:
      properties:
        cli:
          anyOf:
            - type: string
            - type: 'null'
          title: Cli
        api:
          anyOf:
            - type: string
            - type: 'null'
          title: Api
        mcp:
          anyOf:
            - type: string
            - type: 'null'
          title: Mcp
        open:
          anyOf:
            - type: string
            - type: 'null'
          title: Open
      type: object
      title: NextStep
      description: >-
        One way forward, spelled for each surface. `open` is a page a person
        must visit.
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: Standard error envelope with operation-specific JSON context.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `floo_` API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.