Get Audit Logs

Get Audit Logs

get audit logs based on filters specified in query

Request
URI
POST
https://{api_host}/api/ni/logs/audit
COPY
Request Body

Query Filters

AuditRequest of type(s) application/json
Required 
{
    "username": "admin@local",
    "operation": "LOGIN",
    "time_range": {
        "start_time": 1534410000,
        "end_time": 1534410559
    },
    "size": 10,
    "cursor": "string"
}
string
user_name
Optional

Username making the change

string
ip_address
Optional

Client IP that is making the change

string
entity_type
Optional

Entity Type of object being changed

string
entity_id
Optional

Entity ID of object being changed

string
operation
Optional

Operation on object being changed

string
response
Optional

Response from Operations for Networks, whether it's successfull or not

integer As int32 As int32
size
Optional

size

string
cursor
Optional

Cursor for the next page of logs

TimeRange
time_range
Optional

time_range

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AuditListResponse of type(s) application/json 
{
    "results": [
        {
            "ip_address": "string",
            "user_name": "string",
            "entity_type": "string",
            "entity_id": "string",
            "operation": "string",
            "response": "string",
            "value": "string",
            "timestamp": 0
        }
    ],
    "cursor": "ML12eu02==",
    "start_time": 1504739809,
    "end_time": 1504739809
}
array of AuditResponse
results
Optional

results

string
cursor
Optional

Cursor for the next page of logs

integer As int64 As int64
start_time
Optional

Start timestamp of the window of the objects returned

integer As int64 As int64
end_time
Optional

End timestamp of the window of the objects returned


400

Bad Request

Returns ApiError of type(s) application/json 
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}
integer As int32 As int32
code
Optional

code

string
message
Optional

message

array of ErrorDetail
details
Optional

details


401

Unauthorized

Operation doesn't return any data structure

500

Internal Error

Operation doesn't return any data structure

On This Page
Logs Operations
POST
Get Audit Logs