API v2: Logs¶
System log is an internal registry of users activities which influence system state (login information, administrative actions, etc.).
Data Structures¶
| Attribute | Type | Required | Description |
|---|---|---|---|
| id | string | Unique and read-only object Identifier | |
| facility_name | string | yes | Unique, read-only, and case-insensitive facility name. |
| severity_id | string {2 = Critical, 3 = Error, 4 = Warning, 6 = Info, 7 = Debug} | yes | Read-only |
| type_name | string | yes | Read-only |
| debuglevel | string | yes | Read-only |
| message | string | yes | Read-only |
| account_id | string | Read-only | |
| account_name | string | Read-only | |
| account_removed | boolean | Read-only. Account removed status. | |
| account_secret_id | string | Read-only | |
| account_secret_removed | boolean | Read-only. Account secret removed status. | |
| listener_id | string | Read-only | |
| listener_name | string | Read-only | |
| listener_removed | boolean | Read-only. Listener removed status. | |
| pool_id | string | Read-only | |
| pool_name | string | Read-only | |
| pool_removed | boolean | Read-only. Pool removed status. | |
| safe_id | string | Read-only | |
| safe_name | string | Read-only | |
| safe_removed | boolean | Read-only. Safe removed status. | |
| session_id | string | Read-only | |
| server_id | string | Read-only | |
| server_name | string | Read-only | |
| server_removed | boolean | Read-only. Server removed status. | |
| subject_id | string | Read-only. ID of the object that is the subject of this log, e.g. superadmin giving operator access to user. | |
| subject_name | string | Read-only | |
| subject_removed | boolean | Read-only. Subject removed status. | |
| user_id | string | Read-only | |
| user_name | string | Read-only | |
| user_removed | boolean | Read-only. User removed status. | |
| user_extra_id | string | Read-only. E.g., ID of the user whose specifications another user was granted access to. | |
| user_extra_name | string | Read-only | |
| user_extra_removed | boolean | Read-only. User extra removed status. | |
| node_serial | string | Read-only | |
| node_name | string | Read-only | |
| created_at | datetime | Read-only. Timestamp of creation. | |
| modified_at | datetime | Read-only. Timestamp of modification. | |
| removed | boolean | Read-only |
Request for Retrieving Available Attributes of the LogModel
| Method | GET
|
| Path | /api/v2/objspec/log
|
Note
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
The next chapter describes procedures for creating separate requests.
Retrieving Log List¶
Example Request
Sending GET https://10.0.0.0/api/v2/log
curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/log'