Plugins

List all install plugins.<br/>Plugins are launched in top-down order.<br/>Using POST /plugins/{name}/move to change the boot order.

get/plugins

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/plugins
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Response

namestring required

Name-Vsn: without .tar.gz

authorstring[]
built_on_otp_releasestring
compatibilityobject
git_commit_or_build_datestring

Last git commit date by git log -1 --pretty=format:'%cd' --date=format:'%Y-%m-%d.<br/> If the last commit date is not available, the build date will be presented.

functionalitystring[]
git_refstring
metadata_vsnstring
rel_vsnstring required

Plugins release version

rel_appsstring[] required

Aplications in plugin.

repostring
descriptionstring required

Plugin description.

readmestring

only return when GET /plugins/{name}.

Example response

[
  {
    "name": "emqx_plugin_template-5.0-rc.1",
    "author": [
      "EMQX Team"
    ],
    "builder": {
      "contact": "emqx-support@emqx.io",
      "name": "EMQX Team",
      "website": "www.emqx.com"
    },
    "built_on_otp_release": "24",
    "compatibility": {
      "emqx": "~>5.0"
    },
    "git_commit_or_build_date": "2021-12-25",
    "functionality": [
      "Demo"
    ],
    "git_ref": "ddab50fafeed6b1faea70fc9ffd8c700d7e26ec1",
    "metadata_vsn": "0.1.0",
    "rel_vsn": "5.0-rc.1",
    "rel_apps": [
      "emqx_plugin_template-5.0.0",
      "map_sets-1.1.0"
    ],
    "repo": "https://github.com/emqx/emqx-plugin-template",
    "description": "This is an demo plugin description",
    "running_status": [
      {
        "node": "emqx@127.0.0.1"
      }
    ],
    "readme": "This is an demo plugin."
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.