Plugins

Resources related to Plugins.

Plugins

The Plugins resource represents a plugin installed in the system.

List resource

GET /api/v1.0/plugins/plugins/

Returns a list of all plugins.

Example request:

GET /api/v1.0/plugins/plugins/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
  {
    "id": 1,
    "plugin_api_version": "2",
    "plugin_arch": "amd64",
    "plugin_enabled": true,
    "plugin_ip": "-",
    "plugin_jail": "transmission_1",
    "plugin_name": "transmission",
    "plugin_path": "/usr/pbi/transmission-amd64",
    "plugin_pbiname": "transmission-2.82-amd64",
    "plugin_port": 12346,
    "plugin_version": "2.82"
  }
]
Query Parameters:
 
  • offset – offset number. default is 0
  • limit – limit number. default is 20
Response Headers:
 
  • Content-Type – content type of the response
Status Codes:
  • 200 – no error

Start plugin

POST /api/v1.0/plugins/plugins/(int: id)/start/

Starts a plugin service.

Example request:

POST /api/v1.0/plugins/plugins/1/start/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 202 Accepted
Vary: Accept
Content-Type: application/json

  Plugin started.
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 202 – no error

Stop plugin

POST /api/v1.0/plugins/plugins/(int: id)/stop/

Stops a plugin service.

Example request:

POST /api/v1.0/plugins/plugins/1/stop/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 202 Accepted
Vary: Accept
Content-Type: application/json

  Plugin stopped.
Request Headers:
 
  • Content-Type – the request content type
Response Headers:
 
  • Content-Type – the response content type
Status Codes:
  • 202 – no error

Delete resource

DELETE /api/v1.0/plugins/plugins/(int: id)/

Delete plugin id.

Example request:

DELETE /api/v1.0/plugins/plugins/1/ HTTP/1.1
Content-Type: application/json

Example response:

HTTP/1.1 204 No Response
Vary: Accept
Content-Type: application/json
Status Codes:
  • 204 – no error