summaryrefslogtreecommitdiff
path: root/rest-api
diff options
context:
space:
mode:
authorBenjamin Ford <bford@digium.com>2015-07-29 14:17:09 -0500
committerBenjamin Keith Ford <bford@digium.com>2015-07-31 11:46:08 -0500
commit1f02d20da41ef79e913317795e44dbc6a34464f9 (patch)
tree1dad3d3a1e9c9cf3bcdddd8136aeb1ed23e194f8 /rest-api
parentd61ea4bcc28a9504d44534f435be1515d713a496 (diff)
ARI: Rotate log channels.
An http request can be sent to rotate a specified log channel. If the channel does not exist, an error response will be returned. The command "curl -v -u user:pass -X PUT 'http://localhost:8088 /ari/asterisk/logging/logChannelName/rotate'" can be run in the terminal to access this new functionality. * Added the ability to rotate log files through ARI ASTERISK-25252 Change-Id: Iaefa21cbbc1b29effb33004ee3d89c977e76ab01
Diffstat (limited to 'rest-api')
-rw-r--r--rest-api/api-docs/asterisk.json54
1 files changed, 54 insertions, 0 deletions
diff --git a/rest-api/api-docs/asterisk.json b/rest-api/api-docs/asterisk.json
index 2705f45f6..5109419d7 100644
--- a/rest-api/api-docs/asterisk.json
+++ b/rest-api/api-docs/asterisk.json
@@ -297,6 +297,34 @@
]
},
{
+ "path": "/asterisk/logging/{logChannelName}/rotate",
+ "description": "Asterisk log channel",
+ "operations": [
+ {
+ "httpMethod": "PUT",
+ "summary": "Rotates a log channel.",
+ "nickname": "rotateLog",
+ "responseClass": "void",
+ "parameters": [
+ {
+ "name": "logChannelName",
+ "description": "Log channel's name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Log channel does not exist."
+ }
+ ]
+ }
+ ]
+ },
+ {
"path": "/asterisk/variable",
"description": "Global variables",
"operations": [
@@ -533,6 +561,32 @@
}
}
},
+ "LogChannel": {
+ "id": "LogChannel",
+ "description": "Details of an Asterisk log channel",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The log channel path",
+ "required": true
+ },
+ "type": {
+ "type": "string",
+ "description": "Types of logs for the log channel",
+ "required": true
+ },
+ "status": {
+ "type": "string",
+ "description": "Whether or not a log type is enabled",
+ "required": true
+ },
+ "configuration": {
+ "type": "string",
+ "description": "The various log levels",
+ "required": true
+ }
+ }
+ },
"Variable": {
"id": "Variable",
"description": "The value of a channel variable",