Windmill

Windmill Git Sync API

The Git Sync API from Windmill — 7 operation(s) for git sync.

GitHub OpenAPI

Operations 7

GET /github_app/connected_repositories Get Connected Repositories #
POST /w/{workspace}/github_app/install_from_workspace Install a GitHub Installation from Another Workspace #
DELETE /w/{workspace}/github_app/installation/{installation_id} Delete a GitHub Installation from a Workspace #
GET /w/{workspace}/github_app/export/{installationId} Export GitHub Installation JWT Token #
POST /w/{workspace}/github_app/import Import GitHub Installation from JWT Token #
POST /w/{workspace}/github_app/ghes_installation_callback GHES Installation Callback #
GET /github_app/ghes_config Get GHES App Config #

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://artifacts.apis.io/windmill/openapi/windmill-git-sync-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://artifacts.apis.io/windmill/rules/windmill-api-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/windmill:windmill-git-sync-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

windmill-git-sync-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill Git Sync API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Git Sync
paths:
  /github_app/connected_repositories:
    get:
      summary: Get Connected Repositories
      operationId: getGlobalConnectedRepositories
      tags:
      - Git Sync
      parameters:
      - name: page
        in: query
        description: Page number for pagination (default 1)
        required: false
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: connected repositories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubInstallations'
  /w/{workspace}/github_app/install_from_workspace:
    post:
      tags:
      - Git Sync
      summary: Install a GitHub Installation from Another Workspace
      operationId: installFromWorkspace
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                source_workspace_id:
                  type: string
                  description: The ID of the workspace containing the installation to copy
                installation_id:
                  type: number
                  description: The ID of the GitHub installation to copy
              required:
              - source_workspace_id
              - installation_id
      responses:
        '200':
          description: Installation successfully copied
  /w/{workspace}/github_app/installation/{installation_id}:
    delete:
      summary: Delete a GitHub Installation from a Workspace
      operationId: deleteFromWorkspace
      description: Removes a GitHub installation from the specified workspace. Requires admin privileges.
      tags:
      - Git Sync
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: installation_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
        description: The ID of the GitHub installation to delete
      responses:
        '200':
          description: Installation successfully deleted
  /w/{workspace}/github_app/export/{installationId}:
    get:
      summary: Export GitHub Installation JWT Token
      description: Exports the JWT token for a specific GitHub installation in the workspace
      operationId: exportInstallation
      tags:
      - Git Sync
      parameters:
      - name: workspace
        in: path
        required: true
        schema:
          type: string
      - name: installationId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successfully exported the JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt_token:
                    type: string
  /w/{workspace}/github_app/import:
    post:
      summary: Import GitHub Installation from JWT Token
      description: Imports a GitHub installation from a JWT token exported from another instance
      operationId: importInstallation
      tags:
      - Git Sync
      parameters:
      - name: workspace
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - jwt_token
              properties:
                jwt_token:
                  type: string
      responses:
        '200':
          description: Successfully imported the installation
  /w/{workspace}/github_app/ghes_installation_callback:
    post:
      summary: GHES Installation Callback
      description: Register a self-managed GitHub App installation from GitHub Enterprise Server
      operationId: ghesInstallationCallback
      tags:
      - Git Sync
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - installation_id
              properties:
                installation_id:
                  type: integer
                  format: int64
                  description: The GitHub App installation ID from GHES
      responses:
        '200':
          description: GHES installation registered successfully
  /github_app/ghes_config:
    get:
      summary: Get GHES App Config
      description: Returns the GitHub Enterprise Server app configuration (without private key) for constructing the installation URL
      operationId: getGhesConfig
      tags:
      - Git Sync
      responses:
        '200':
          description: GHES app configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  base_url:
                    type: string
                  app_slug:
                    type: string
                  client_id:
                    type: string
                  app_owner:
                    type:
                    - string
                    - 'null'
                required:
                - base_url
                - app_slug
                - client_id
components:
  schemas:
    GithubInstallations:
      type: array
      items:
        type: object
        properties:
          workspace_id:
            type: string
          installation_id:
            type: number
          account_id:
            type: string
          repositories:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                url:
                  type: string
              required:
              - name
              - url
          total_count:
            type: number
            description: Total number of repositories available for this installation
          per_page:
            type: number
            description: Number of repositories loaded per page
          error:
            type: string
            description: Error message if token retrieval failed
        required:
        - installation_id
        - account_id
        - repositories
        - total_count
        - per_page
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev
x-provenance:
  method: harvested
  publisher: Windmill
  source: https://app.windmill.dev/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)