Log - Distributed Secure Internet GateWay API References (1.5.0)

Download OpenAPI specification:Download

Get specific cell-group's security logs.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

log

Get Traffic Logs

Get traffic logs.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

string

query Parameters

receiveTimeFrom	string ^[0-9]{4}-(0[1-9]{1}\|1[0-2]{1})-(0[1-9]\|[1-2][0-9]\|3[0-1])T(0[0-9]\|1[0-9]\|2[0-3]):(0[0-9]\|[1-5][0-9]):(0[0-9]\|[1-5][0-9])Z$ The start time for search.
receiveTimeTo	string ^[0-9]{4}-(0[1-9]{1}\|1[0-2]{1})-(0[1-9]\|[1-2][0-9]\|3[0-1])T(0[0-9]\|1[0-9]\|2[0-3]):(0[0-9]\|[1-5][0-9]):(0[0-9]\|[1-5][0-9])Z$ The end time for search.
offset	integer [ 0 .. 10000000 ] Default: 0 The offset for the displaying rows.
limit	integer [ 0 .. 5000 ] Default: 1 The limit for the displaying rows.
sort	string Default: "timestamp:desc" The query for sort (specify like key1:desc,key2:asc).
filterType	string Default: "exact" Enum: "exact" "partial" "regexp" Specify filter type of query string for logs keys.
action	string
actionFlags	string
actionSource	string
application	string
bytes	string
bytesReceived	string
bytesSent	string
category	string
configVersion	string
cpadding	string
destinationAddress	string
destinationCountry	string
destinationPort	string
destinationUser	string
destinationVmUuid	string
destinationZone	string
deviceName	string
dgHierarchyLevel1	string
dgHierarchyLevel2	string
dgHierarchyLevel3	string
dgHierarchyLevel4	string
domain	string
elapsedTimeSec	string
flags	string
generateTime	string
inboundInterface	string
ipProtocol	string
logAction	string
monitorTagImei	string
natDestinationIp	string
natDestinationPort	string
natSourceIp	string
natSourcePort	string
outboundInterface	string
packets	string
packetsReceived	string
packetsSent	string
parentSessionId	string
parentSessionStartTime	string
receiveTime	string
repeatCount	string
rule	string
sctpAssociationId	string
sctpChunks	string
sctpChunksReceived	string
sctpChunksSent	string
sequenceNumber	string
serial	string
sessionEndReason	string
sessionId	string
sourceAddress	string
sourceCountry	string
sourcePort	string
sourceUser	string
sourceVmUuid	string
sourceZone	string
startTime	string
threatContentType	string
timeLogged	string
tpadding	string
tunnel	string
tunnelIdImsi	string
type	string
virtualSystem	string
virtualSystemName	string
uuidForRule	string
http2Connection	string
linkChangeCount	string
policyId	string
linkSwitches	string
sdwanCluster	string
sdwanDeviceType	string
sdwanClusterType	string
sdwanSite	string
dynusergroupName	string

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/cell-groups/{cell_group_id}/logs/traffics

https://api.ntt.com/dsigw-erg/v1/cell-groups/{cell_group_id}/logs/traffics

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"trafficLogs": 
[
{"action": "allow",
"actionFlags": "0x0",
"actionSource": "from-policy",
"application": "web-browsing",
"bytes": "1201356",
"bytesReceived": "255081",
"bytesSent": "946275",
"category": "shopping",
"configVersion": "2049",
"cpadding": "0",
"destinationAddress": "203.0.113.4",
"destinationCountry": "Japan",
"destinationPort": "443",
"destinationUser": "",
"destinationVmUuid": "",
"destinationZone": "Untrust",
"deviceName": "35c439-utm",
"dgHierarchyLevel1": "0",
"dgHierarchyLevel2": "0",
"dgHierarchyLevel3": "0",
"dgHierarchyLevel4": "0",
"domain": "1",
"elapsedTimeSec": "1809",
"flags": "0x1500070",
"generateTime": "2021/02/08 09:55:24",
"inboundInterface": "ethernet1/2",
"ipProtocol": "tcp",
"logAction": "Syslog_Forward",
"monitorTagImei": "",
"natDestinationIp": "203.0.113.4",
"natDestinationPort": "443",
"natSourceIp": "203.0.113.2",
"natSourcePort": "29013",
"outboundInterface": "ethernet1/1",
"packets": "2432",
"packetsReceived": "864",
"packetsSent": "1568",
"parentSessionId": "0",
"parentSessionStartTime": "",
"receiveTime": "2021/02/08 09:55:24",
"repeatCount": "1",
"rule": "test01",
"sctpAssociationId": "0",
"sctpChunks": "0",
"sctpChunksReceived": "0",
"sctpChunksSent": "0",
"sequenceNumber": "13119",
"serial": "000000000000000",
"sessionEndReason": "tcp-fin",
"sessionId": "169882",
"sourceAddress": "10.0.0.2",
"sourceCountry": "10.0.0.0-10.255.255.255",
"sourcePort": "3567",
"sourceUser": "",
"sourceVmUuid": "",
"sourceZone": "Trust",
"startTime": "2021/02/08 09:24:58",
"threatContentType": "end",
"timeLogged": "2021/02/08 09:55:24",
"tpadding": "0",
"tunnel": "N/A",
"tunnelIdImsi": "0",
"type": "TRAFFIC",
"virtualSystem": "vsys1",
"virtualSystemName": "",
"uuidForRule": "",
"http2Connection": "",
"linkChangeCount": "",
"policyId": "",
"linkSwitches": "",
"sdwanCluster": "",
"sdwanDeviceType": "",
"sdwanClusterType": "",
"sdwanSite": "",
"dynusergroupName": ""
},
{"action": "allow",
"actionFlags": "0x0",
"actionSource": "from-policy",
"application": "ssl",
"bytes": "5185",
"bytesReceived": "4523",
"bytesSent": "662",
"category": "any",
"configVersion": "2049",
"cpadding": "0",
"destinationAddress": "203.0.113.6",
"destinationCountry": "United States",
"destinationPort": "443",
"destinationUser": "",
"destinationVmUuid": "",
"destinationZone": "Untrust",
"deviceName": "35c439-utm",
"dgHierarchyLevel1": "0",
"dgHierarchyLevel2": "0",
"dgHierarchyLevel3": "0",
"dgHierarchyLevel4": "0",
"domain": "1",
"elapsedTimeSec": "253",
"flags": "0x1400070",
"generateTime": "2021/02/08 09:51:08",
"inboundInterface": "ethernet1/2",
"ipProtocol": "tcp",
"logAction": "Syslog_Forward",
"monitorTagImei": "",
"natDestinationIp": "203.0.113.6",
"natDestinationPort": "443",
"natSourceIp": "203.0.113.2",
"natSourcePort": "7431",
"outboundInterface": "ethernet1/1",
"packets": "16",
"packetsReceived": "9",
"packetsSent": "7",
"parentSessionId": "0",
"parentSessionStartTime": "",
"receiveTime": "2021/02/08 09:51:08",
"repeatCount": "1",
"rule": "test01",
"sctpAssociationId": "0",
"sctpChunks": "0",
"sctpChunksReceived": "0",
"sctpChunksSent": "0",
"sequenceNumber": "13118",
"serial": "000000000000000",
"sessionEndReason": "tcp-fin",
"sessionId": "171933",
"sourceAddress": "10.0.0.2",
"sourceCountry": "10.0.0.0-10.255.255.255",
"sourcePort": "18792",
"sourceUser": "",
"sourceVmUuid": "",
"sourceZone": "Trust",
"startTime": "2021/02/08 09:46:38",
"threatContentType": "end",
"timeLogged": "2021/02/08 09:51:08",
"tpadding": "0",
"tunnel": "N/A",
"tunnelIdImsi": "0",
"type": "TRAFFIC",
"virtualSystem": "vsys1",
"virtualSystemName": "",
"uuidForRule": "",
"http2Connection": "",
"linkChangeCount": "",
"policyId": "",
"linkSwitches": "",
"sdwanCluster": "",
"sdwanDeviceType": "",
"sdwanClusterType": "",
"sdwanSite": "",
"dynusergroupName": ""
}
]
}

Get Threat Logs

Get threat logs.

Authorizations:

X-Auth-Token

path Parameters

cell_group_id

required

string

query Parameters

receiveTimeFrom	string ^[0-9]{4}-(0[1-9]{1}\|1[0-2]{1})-(0[1-9]\|[1-2][0-9]\|3[0-1])T(0[0-9]\|1[0-9]\|2[0-3]):(0[0-9]\|[1-5][0-9]):(0[0-9]\|[1-5][0-9])Z$ The start time for search.
receiveTimeTo	string ^[0-9]{4}-(0[1-9]{1}\|1[0-2]{1})-(0[1-9]\|[1-2][0-9]\|3[0-1])T(0[0-9]\|1[0-9]\|2[0-3]):(0[0-9]\|[1-5][0-9]):(0[0-9]\|[1-5][0-9])Z$ The end time for search.
offset	integer [ 0 .. 10000000 ] Default: 0 The offset for the displaying rows.
limit	integer [ 0 .. 5000 ] Default: 1 The limit for the displaying rows.
sort	string Default: "timestamp:desc" The query for sort (specify like key1:desc,key2:asc).
filterType	string Default: "exact" Enum: "exact" "partial" "regexp" Specify filter type of query string for logs keys.
action	string
actionFlags	string
application	string
category	string
cloud	string
configVersion	string
contenttype	string
contentver	string
cpadding	string
destinationAddress	string
destinationCountry	string
destinationPort	string
destinationUser	string
destinationVmUuid	string
destinationZone	string
deviceName	string
dgHierarchyLevel1	string
dgHierarchyLevel2	string
dgHierarchyLevel3	string
dgHierarchyLevel4	string
direction	string
domain	string
fileUrl	string
filedigest	string
filetype	string
flags	string
generateTime	string
httpHeaders	string
httpMethod	string
inboundInterface	string
ipProtocol	string
logAction