---
title: "Install a plugin from GitHub"
method: POST
path: "/api/v1/plugins/install/github"
tags: ["Plugins"]
---

# Install a plugin from GitHub

`POST /api/v1/plugins/install/github`

## Request body

- PluginGithubInstallRequest
  - `repository` string, required — GitHub URL or owner/repository slug.
  - `ref` string
  - `download_url` string — Optional downloadable ZIP URL to use instead of GitHub archive resolution.
  - `proxy` string
  - `ignore_version_check` boolean

## Response `200`

Standard AstrBot success response

- SuccessEnvelope
  - `status` 'ok', required
  - `message` string
  - `data` unknown, required

## Changes

- **2026-06-14** `6b73b947caab` — 1 info
  - endpoint added
- **2026-03-09** `3d43cee2622a` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1/changes/api/v1/plugins/install/github/post.md)

---

[API](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1.md) · [All operations](https://skmtc.dev/astrbotdevs/apis/astrbot-openapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/astrbotdevs/astrbot-openapi-v1/revisions/0d76e116afe5/schema)