-
Created by Unknown User (anna), last modified on Aug 02, 2013
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Get |
---|
URL | /api/v1/api.php?target=log&action=get |
Description | Returns a list of log entries. Use optional parameters to filter the list. |
Returns | Examples: SUCCESSFUL | {"success":1,"message":"Search Successful.","data":[{"logId":"31568","time": "2012-05-07 17:44:43", "logLevel":"INFO","userId":"39","userName": "anna@6connect.com","logCategory": "User","message": "Anna Claiborne (anna@6connect.com) logged in via local authentication","ip":"107.111.0.228"}]} | ERROR | {'success':0, 'message':'error message'} |
Data Detail
| | | |
---|
logId | INTEGER | 24 | Unique log entry id. | time | DATETIME | 2012-05-07 22:10:07 | Date and time year to second. | logLevel | STRING | NOTICE | Standard syslog log levels in verbose format (EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG). | userId | Integer | 11 | The unique user id associated with the log entry. | userName | STRING | anna@6connect.com | The unique user name associated with the log entry. | logCategory | STRING | IPAM | The 6connect category for the log entry (User, IPAM, Resource Holder, DNS, Peering, Assistant, NTP, Reporting). | message | STRING | Created new children from 1.0.0.0/24 | The detailed log message. | ip | STRING | 107.111.0.228 | The remote IP address of the user who took the action being logged. |
|
Required Parameters | |
Optional Parameters | | | | |
---|
likeFlag | BOOL | 1 | When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used. | logId | INTEGER | 24 | Unique log entry id. | timeStart | DATETIME | 2012-05-07 [21:00:00] | Retrieve logs starting at this Date and optional time year to second. | timeEnd | DATETIME | 2012-05-07 [22:00:00] | Retrieve logs ending at this Date and optional time year to second. | limit | INTEGER | 100 | Total log entries to retrieve. Default limit is 1000 records. | offset | INTEGER | 50 | Offset from 0 to retrieve log entries | userName | STRING | anna@6connect.com | The unique user name associated with the log entry. | logCategory | STRING | IPAM | The 6connect category for the log entry (User, IPAM, Resource Holder, DNS, Peering, Assistant, NTP, Reporting). | logLevel | STRING | NOTICE | Standard syslog log levels in verbose format (EMERG, ALERT, CRIT, ERR, WARNING, NOTICE, INFO, DEBUG). | ip | STRING | 1.2.3.4 | The remote IP address of the user whose action was logged | block | STRING | 1.2.3.4/8 | Used to return any actions performed on the specified block. |
|
Example URL | /api/v1/api.php?target=log&action=get |