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

# Deploy a GitHub repository to a new Vers project.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/deploy
openapi: 3.1.0
info:
  title: Orchestrator Control Plane API
  description: ''
  license:
    name: ''
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/deploy:
    post:
      tags:
        - deploy
      summary: Deploy a GitHub repository to a new Vers project.
      operationId: deploy_handler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployRequest'
        required: true
      responses:
        '202':
          description: Deploy initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeployResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Repository not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Project name conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: GitHub App not configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    DeployRequest:
      type: object
      description: Request body for `POST /api/v1/deploy`.
      required:
        - repo
      properties:
        branch:
          type:
            - string
            - 'null'
          description: Git branch to clone (defaults to repo default branch).
        name:
          type:
            - string
            - 'null'
          description: Optional project name (defaults to repo name).
        repo:
          type: string
          description: GitHub repository in `owner/repo` format.
        settings:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/DeploySettings'
              description: Build/run settings.
    DeployResponse:
      type: object
      description: Response body for `POST /api/v1/deploy`.
      required:
        - project_id
        - vm_id
        - status
      properties:
        project_id:
          type: string
          format: uuid
        status:
          type: string
        vm_id:
          type: string
          format: uuid
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Reason of error
        success:
          type: boolean
          description: 'Is always: false'
    DeploySettings:
      type: object
      description: Settings for the deploy build pipeline.
      properties:
        build_command:
          type:
            - string
            - 'null'
        install_command:
          type:
            - string
            - 'null'
        run_command:
          type:
            - string
            - 'null'
        working_directory:
          type:
            - string
            - 'null'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: Token

````