Documentation: API Endpoint
Plugins
Display a list of entries
GET /plugins/list
Name | Type | Description | Default | Accepted Values |
---|---|---|---|---|
folder | string | Folder (plugin group) |
|
|
enabled | integer | Enabled |
1
|
|
access | integer | Access |
1
|
|
limit | integer | Number of result to return. |
25
|
|
start | integer | Number of where to start returning results. |
0
|
|
search | string | A word or phrase to search for. |
|
|
sort | string | Field to sort results by. |
created
|
created, title, alias, id, publish_up, publish_down, state
|
sort_Dir | string | Direction to sort results by. |
desc
|
asc, desc
|
Create an entry
POST /plugins
Name | Type | Description | Default | Accepted Values |
---|---|---|---|---|
name | string | Required. Name |
null
|
|
element | string | Required. Element |
null
|
|
folder | string | Required. Folder (plugin group) |
null
|
|
enabled | integer | Enabled |
0
|
|
access | integer | Access |
1
|
|
params | string | JSON Encoded list of params |
null
|
Retrieve an entry
GET /plugins/{id}
Name | Type | Description | Default | Accepted Values |
---|---|---|---|---|
id | integer | Required. Extension identifier |
null
|
Update an entry
PUT /plugins/{extension_id}
Name | Type | Description | Default | Accepted Values |
---|---|---|---|---|
extension_id | integer | Required. Extension identifier |
null
|
|
name | string | Name |
null
|
|
element | string | Element |
null
|
|
folder | string | Folder (plugin group) |
null
|
|
enabled | integer | Enabled |
0
|
|
access | integer | Access |
1
|
|
params | string | JSON Encoded list of params |
null
|
Delete an entry
DELETE /plugins/{id}
Name | Type | Description | Default | Accepted Values |
---|---|---|---|---|
extension_id | integer | Required. Extension identifier |
0
|