Plugins

Install a plugin from GitHub

Changed on

Required scope: plugin

post/api/v1/plugins/install/github

Request

  • Base URL
    http://localhost:6185
  • URL
    http://localhost:6185/api/v1/plugins/install/github
  • Auth
    API key in header X-API-Key

Request body

repositorystring required

GitHub shorthand, HTTP(S), SSH, or SCP-style Git repository locator.

refstring
download_urlstring

Optional downloadable ZIP URL to use instead of repository archive resolution.

proxystring
ignore_version_checkboolean
install_methodstring
registry_urlstring nullable
market_plugin_idstring

Response

Standard AstrBot success response

status'ok' required
messagestring
dataunknown required

Changes