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

# Connect a repo

> Links the app to a repo, branch and folder and adds Dojo's webhook to the repo, so each push to the branch deploys. Connecting again replaces the link and reconnects one that needs it. The branch defaults to the repo's default branch, the folder to the root.



## OpenAPI

````yaml https://dojo.frogbot.ai/api/openapi.json put /api/apps/{app}/repo
openapi: 3.1.0
info:
  title: Dojo API
  version: '1'
  description: >-
    Everything Dojo's pages do, for scripts and agents. Sign in with an API key
    as `Authorization: Bearer fb_…`. Paying and accepting the terms happen at a
    link a route answers, for a person to open.
servers:
  - url: https://dojo.frogbot.ai
security:
  - apiKey: []
tags:
  - name: Sign-in
  - name: Workspaces
  - name: Projects
  - name: Apps
  - name: Templates
  - name: Sharing
  - name: Deployments
  - name: Environment variables
  - name: Domains
  - name: Data
  - name: Billing
  - name: API keys
paths:
  /api/apps/{app}/repo:
    put:
      tags:
        - Deployments
      summary: Connect a repo
      description: >-
        Links the app to a repo, branch and folder and adds Dojo's webhook to
        the repo, so each push to the branch deploys. Connecting again replaces
        the link and reconnects one that needs it. The branch defaults to the
        repo's default branch, the folder to the root.
      operationId: put/api/apps/:app/repo
      parameters:
        - name: app
          in: path
          required: true
          description: The app's slug, such as `deals`, or its id.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                instanceURL:
                  type: string
                repoID:
                  type: string
                branch:
                  type: string
                folder:
                  type: string
                credential:
                  type: string
                  description: >-
                    A GitLab access token, stored encrypted and never returned;
                    for GitHub, the signed repo list Connect GitHub hands back.
                grant:
                  type: string
                  description: >-
                    The grant a provider's sign-in returned, in place of
                    `credential`; spent on connect.
              required:
                - provider
                - repoID
            example:
              provider: github
              repoID: '123'
              folder: apps/web
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  repo:
                    anyOf:
                      - type: object
                        properties:
                          provider:
                            type: string
                          instanceURL:
                            type: string
                          repoID:
                            type: string
                          repoName:
                            type: string
                          branch:
                            type: string
                          folder:
                            type: string
                          status:
                            type: string
                            enum:
                              - active
                              - needs-reconnect
                        required:
                          - provider
                          - instanceURL
                          - repoID
                          - repoName
                          - branch
                          - folder
                          - status
                      - type: 'null'
                required:
                  - repo
        '400':
          description: '`invalid_request`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '401':
          description: '`unauthorized`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: '`forbidden`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: '`not_found`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '409':
          description: '`conflict`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '502':
          description: '`upstream_failed`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
components:
  schemas:
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
              data:
                type: object
                properties:
                  code:
                    type: string
                  url:
                    type: string
                    description: Where a person takes the next step, such as paying.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or
        the API keys page.

````

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