Add Log
URL:
POST http://api.aurelon.com/api/v2/log
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- ComputerGUID – required – the Computer GUID
- RipVersion – version of the RIP in x.x.x format
- DeviceGUID
- QueueGUID
- JobGUID
- JobName
- Type – required – One of “log” or “configuration”
- Description – required – the log message
Ex:
{“ComputerGUID”:”00092EA6-fb01-11e5-9b85-793ef2c92c66″,”Type”:”log”,”Description”:”Something went wrong”}
Response:
Content type application/json containing the result of the operation.
Success:
- 200 OK : “Log successfully added”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 404 Not Found : {“Message”:”ComputerGUID is not found”}
- 404 Not Found : {“Message”:”DeviceGUID is not found”}
- 404 Not Found : {“Message”:”QueueGUID is not found”}
- 404 Not Found : {“Message”:”JobGUID is not found”}
- 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””ComputerGUID”, “Type” and “Description” values are required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Add Crash Report
URL:
POST http://api.aurelon.com/api/v2/log/crashreport
Request Headers:
Content-Type : multipart/form-data
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
ApplicationName : Name of the application (e.g. RIP)
OS : macOS or Windows (currently 0 or 1)
Request Body:
Form data 1 (CallStack): required
- Name: any
- Content-Type: text/plain
Form data 2 (Xml): optional
- Name: any
- Content-Type: application/xml
Form data 3 (dump): optional
- Name: any
- Content-Type: application/octet-stream
Response: Content type of the response is in JSON format but this can be changed by the request client using accept request headers (ex. for XML format accept: application/xml)
Success:
- 200 OK : “Crash report successfully added”
Error:
- 401 Unauthorized : {“Message”: “”HardwareHash” header required; “SerialNumber” header required; “ApplicationVersion” header required”}
- 401 Unauthorized : {“Message”:””HardwareHash” header is invalid”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}
Get Logs
Get all logs from the organization
URL:
POST http://api.aurelon.com/api/v2/log/list
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing one or more of the following filters:
- SerialNumber
- User
- Source
- Version
- Computer
- DateTime – Range of date-time in UTC
- From
- To
- LogType – one of “Log” or “Configuration”
Ex:
{“Version”:”5.0.11″,”Computer”:”Mac-mini-2″,”LogType”:”Log”}
Response:
Return the organization logs filtered by request body filter
Success:
- 200 OK : Return logs list
[{
“User”: “Chuck Laz”,
“Source”: “Rip”,
“Version”: “5.0.13”,
“Computer”: “Computer1”,
“Description”: “Invalid event. Content could not be created from the RIP event.”
}, {
“User”: “f.montgomery”,
“Source”: “Rip”,
“Version”: “5.0.13”,
“Computer”: “Computer2”,
“Description”: “RESTClient::UpdateResource – Resource file not found – “
}]
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”:”Invalid MisKey”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”:””ComputerGUID”, “Type” and “Description” values are required”}
- 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}