Log - Flexible Secure 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:
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 ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

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":
    [
    ]
}

Get Threat Logs

Get threat logs.

Authorizations:
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
string
monitorTagImei
string
natDestinationIp
string
natDestinationPort
string
natSourceIp
string
natSourcePort
string
outboundInterface
string
parentSessionId
string
parentSessionStartTime
string
payloadProtocolId
string
pcapId
string
receiveTime
string
recipient
string
referer
string
repeatCount
string
reportid
string
rule
string
sctpAssociationId
string
sender
string
sequenceNumber
string
serial
string
sessionId
string
severity
string
sigFlags
string
sourceAddress
string
sourceCountry
string
sourcePort
string
sourceUser
string
sourceVmUuid
string
sourceZone
string
subject
string
thrCategory
string
threatContentName
string
threatContentType
string
timeLogged
string
tunnel
string
tunnelIdImsi
string
type
string
urlFilename
string
urlIdx
string
userAgent
string
virtualSystemName
string
virtualSystem
string
xff
string
urlCategoryList
string
uuidForRule
string
http2Connection
string
dynusergroupName
string
header Parameters
X-Auth-Token
required
string ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "threatLogs":
    [
    ]
}

Get Authentication Logs

Get authentication logs.

Authorizations:
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.

domain
string
receiveTime
string
serial
string
type
string
threatContentType
string
configVersion
string
generateTime
string
virtualSystem
string
sourceIp
string
user
string
normalizeUser
string
object
string
authenticationPolicy
string
repeatCount
string
authenticationId
string
vendor
string
logAction
string
serverprofile
string
desc
string
clientType
string
eventType
string
factorNumber
string
sequenceNumber
string
actionFlags
string
dgHierarchyLevel1
string
dgHierarchyLevel2
string
dgHierarchyLevel3
string
dgHierarchyLevel4
string
virtualSystemName
string
deviceName
string
virtualSystemId
string
authproto
string
uuidForRule
string
header Parameters
X-Auth-Token
required
string ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "authenticationLogs":
    [
    ]
}

Get User-ID Logs

Get User-ID logs.

Authorizations:
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.

domain
string
receiveTime
string
serial
string
type
string
threatContentType
string
configVersion
string
generateTime
string
virtualSystem
string
sourceIp
string
user
string
dataSourceName
string
eventId
string
repeatCount
string
timeout
string
beginport
string
endport
string
dataSource
string
dataSourceType
string
sequenceNumber
string
actionFlags
string
dgHierarchyLevel1
string
dgHierarchyLevel2
string
dgHierarchyLevel3
string
dgHierarchyLevel4
string
virtualSystemName
string
deviceName
string
virtualSystemId
string
factorType
string
factorCompletionTime
string
factorNumber
string
ugflags
string
userbysource
string
header Parameters
X-Auth-Token
required
string ^[a-fA-F0-9]{32}$

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "userIdLogs":
    [
    ]
}