diff options
author | Benjamin Ford <bford@digium.com> | 2015-07-14 08:55:14 -0500 |
---|---|---|
committer | Benjamin Keith Ford <bford@digium.com> | 2015-07-14 08:59:27 -0500 |
commit | f64f1c2772909779758cb8cf7f3a328e0ec5ffd1 (patch) | |
tree | 52fec96d1e4cba3142d5c82d85cd04baf922f489 /rest-api/api-docs/asterisk.json | |
parent | aa5707b8891119741baae98cf7b51a00c0f99438 (diff) |
ARI: Added new functionality to unload a single module.
An http request can be sent to unload an Asterisk module. If the
module can not be unloaded or is already unloaded, an error response
will be returned.
The command "curl -v -u user:pass -X DELETE 'http://localhost:8088
/ari/asterisk/modules/{moduleName}'" (or something similar, depending
on configuration) can be run in the terminal to access this new
functionality.
For more information, see:
https://wiki.asterisk.org/wiki.display/~bford/Asterisk+ARI+Resource
* Added new ARI functionality
* Asterisk modules can be unloaded through http requests
ASTERISK-25173
Change-Id: I535a95f5676deb02651522761ecbdc0b00b5ac57
Diffstat (limited to 'rest-api/api-docs/asterisk.json')
-rw-r--r-- | rest-api/api-docs/asterisk.json | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json index dcbfb2c7b..28badce80 100644 --- a/rest-api/api-docs/asterisk.json +++ b/rest-api/api-docs/asterisk.json @@ -101,6 +101,32 @@ "reason": "Module could not be loaded." } ] + }, + { + "httpMethod": "DELETE", + "summary": "Unload an Asterisk module.", + "nickname": "unloadModule", + "responseClass": "void", + "parameters": [ + { + "name": "moduleName", + "description": "Module's name", + "paramType": "path", + "required": true, + "allowMultiple": false, + "dataType": "string" + } + ], + "errorResponses": [ + { + "code": 404, + "reason": "Module not found in running modules." + }, + { + "code": 409, + "reason": "Module could not be unloaded." + } + ] } ] }, |