Documentation Powered by ReDoc

Log - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

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

The ID of the cell group.

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

Filter by the action type.

actionFlags
string

Filter by the action flags.

actionSource
string

Filter by the action source.

application
string

Filter by the application name.

bytes
string

Filter by the total bytes.

bytesReceived
string

Filter by the received bytes.

bytesSent
string

Filter by the sent bytes.

category
string

Filter by the category.

configVersion
string

Filter by the configuration version.

cpadding
string

Filter by the cpadding.

destinationAddress
string

Filter by the destination address.

destinationCountry
string

Filter by the destination country.

destinationPort
string

Filter by the destination port.

destinationUser
string

Filter by the destination user.

destinationVmUuid
string

Filter by the destination VM UUID.

destinationZone
string

Filter by the destination zone.

deviceName
string

Filter by the device name.

dgHierarchyLevel1
string

Filter by the data group hierarchy level 1.

dgHierarchyLevel2
string

Filter by the data group hierarchy level 2.

dgHierarchyLevel3
string

Filter by the data group hierarchy level 3.

dgHierarchyLevel4
string

Filter by the data group hierarchy level 4.

domain
string

Filter by the domain.

elapsedTimeSec
string

Filter by the elapsed time in seconds.

flags
string

Filter by the log flags.

generateTime
string

Filter by the log generation time.

inboundInterface
string

Filter by the inbound interface.

ipProtocol
string

Filter by the IP protocol.

logAction
string

Filter by the log action.

monitorTagImei
string

Filter by the monitor tag IMEI.

natDestinationIp
string

Filter by the NAT destination IP.

natDestinationPort
string

Filter by the NAT destination port.

natSourceIp
string

Filter by the NAT source IP.

natSourcePort
string

Filter by the NAT source port.

outboundInterface
string

Filter by the outbound interface.

packets
string

Filter by the total packets.

packetsReceived
string

Filter by the received packets.

packetsSent
string

Filter by the sent packets.

parentSessionId
string

Filter by the parent session ID.

parentSessionStartTime
string

Filter by the parent session start time.

receiveTime
string

Filter by the receive time.

repeatCount
string

Filter by the repeat count.

rule
string

Filter by the rule.

sctpAssociationId
string

Filter by the SCTP association ID.

sctpChunks
string

Filter by the SCTP chunks.

sctpChunksReceived
string

Filter by the SCTP chunks received.

sctpChunksSent
string

Filter by the SCTP chunks sent.

sequenceNumber
string

Filter by the sequence number.

serial
string

Filter by the serial number.

sessionEndReason
string

Filter by the session end reason.

sessionId
string

Filter by the session ID.

sourceAddress
string

Filter by the source address.

sourceCountry
string

Filter by the source country.

sourcePort
string

Filter by the source port.

sourceUser
string

Filter by the source user.

sourceVmUuid
string

Filter by the source VM UUID.

sourceZone
string

Filter by the source zone.

startTime
string

Filter by the start time.

threatContentType
string

Filter by the threat content type.

timeLogged
string

Filter by the time logged.

tpadding
string

Filter by the tpadding.

tunnel
string

Filter by the tunnel.

tunnelIdImsi
string

Filter by the tunnel ID (IMSI).

type
string

Filter by the log type.

virtualSystem
string

Filter by the virtual system.

virtualSystemName
string

Filter by the virtual system name.

uuidForRule
string

Filter by the UUID for the rule.

http2Connection
string

Filter by the HTTP/2 connection.

linkChangeCount
string

Filter by the link change count.

policyId
string

Filter by the policy ID.

linkSwitches
string

Filter by the link switches.

sdwanCluster
string

Filter by the SD-WAN cluster.

sdwanDeviceType
string

Filter by the SD-WAN device type.

sdwanClusterType
string

Filter by the SD-WAN cluster type.

sdwanSite
string

Filter by the SD-WAN site.

dynusergroupName
string

Filter by the dynamic user group name.

header Parameters
X-Auth-Token
required
string

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:
X-Auth-Token
path Parameters
cell_group_id
required
string

The ID of the cell group.

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

Filter by the action type.

actionFlags
string

Filter by the action flags.

application
string

Filter by the application name.

category
string

Filter by the category.

cloud
string

Filter by the cloud.

configVersion
string

Filter by the configuration version.

contenttype
string

Filter by the content type.

contentver
string

Filter by the content version.

cpadding
string

Filter by the cpadding.

destinationAddress
string

Filter by the destination address.

destinationCountry
string

Filter by the destination country.

destinationPort
string

Filter by the destination port.

destinationUser
string

Filter by the destination user.

destinationVmUuid
string

Filter by the destination VM UUID.

destinationZone
string

Filter by the destination zone.

deviceName
string

Filter by the device name.

dgHierarchyLevel1
string

Filter by the data group hierarchy level 1.

dgHierarchyLevel2
string

Filter by the data group hierarchy level 2.

dgHierarchyLevel3
string

Filter by the data group hierarchy level 3.

dgHierarchyLevel4
string

Filter by the data group hierarchy level 4.

direction
string

Filter by the direction.

domain
string

Filter by the domain.

fileUrl
string

Filter by the file URL.

filedigest
string

Filter by the file digest.

filetype
string

Filter by the file type.

flags
string

Filter by the flags.

generateTime
string

Filter by the generate time.

httpHeaders
string

Filter by the HTTP headers.

httpMethod
string

Filter by the HTTP method.

inboundInterface
string

Filter by the inbound interface.

ipProtocol
string

Filter by the IP protocol.

logAction
string

Filter by the log action.

monitorTagImei
string

Filter by the monitor tag IMEI.

natDestinationIp
string

Filter by the NAT destination IP.

natDestinationPort
string

Filter by the NAT destination port.

natSourceIp
string

Filter by the NAT source IP.

natSourcePort
string

Filter by the NAT source port.

outboundInterface
string

Filter by the outbound interface.

parentSessionId
string

Filter by the parent session ID.

parentSessionStartTime
string

Filter by the parent session start time.

payloadProtocolId
string

Filter by the payload protocol ID.

pcapId
string

Filter by the pcap ID.

receiveTime
string

Filter by the receive time.

recipient
string

Filter by the recipient.

referer
string

Filter by the referer.

repeatCount
string

Filter by the repeat count.

reportid
string

Filter by the report ID.

rule
string

Filter by the rule.

sctpAssociationId
string

Filter by the SCTP association ID.

sender
string

Filter by the sender.

sequenceNumber
string

Filter by the sequence number.

serial
string

Filter by the serial number.

sessionId
string

Filter by the session ID.

severity
string

Filter by the severity.

sigFlags
string

Filter by the signature flags.

sourceAddress
string

Filter by the source address.

sourceCountry
string

Filter by the source country.

sourcePort
string

Filter by the source port.

sourceUser
string

Filter by the source user.

sourceVmUuid
string

Filter by the source VM UUID.

sourceZone
string

Filter by the source zone.

subject
string

Filter by the subject.

thrCategory
string

Filter by the threat category.

threatContentName
string

Filter by the threat content name.

threatContentType
string

Filter by the threat content type.

timeLogged
string

Filter by the time logged.

tunnel
string

Filter by the tunnel.

tunnelIdImsi
string

Filter by the tunnel ID (IMSI).

type
string

Filter by the log type.

urlFilename
string

Filter by the URL filename.

urlIdx
string

Filter by the URL index.

userAgent
string

Filter by the user agent.

virtualSystemName
string

Filter by the virtual system name.

virtualSystem
string

Filter by the virtual system.

xff
string

Filter by the X-Forwarded-For header.

urlCategoryList
string

Filter by the URL category list.

uuidForRule
string

Filter by the UUID for the rule.

http2Connection
string

Filter by the HTTP/2 connection.

dynusergroupName
string

Filter by the dynamic user group name.

header Parameters
X-Auth-Token
required
string

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:
X-Auth-Token
path Parameters
cell_group_id
required
string

The ID of the cell group.

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

Filter by the domain.

receiveTime
string

Filter by the receive time.

serial
string

Filter by the serial number.

type
string

Filter by the log type.

threatContentType
string

Filter by the threat content type.

configVersion
string

Filter by the configuration version.

generateTime
string

Filter by the generate time.

virtualSystem
string

Filter by the virtual system.

sourceIp
string

Filter by the source IP address.

user
string

Filter by the user.

normalizeUser
string

Filter by the normalized user.

object
string

Filter by the object.

authenticationPolicy
string

Filter by the authentication policy.

repeatCount
string

Filter by the repeat count.

authenticationId
string

Filter by the authentication ID.

vendor
string

Filter by the vendor.

logAction
string

Filter by the log action.

serverprofile
string

Filter by the server profile.

desc
string

Filter by the description.

clientType
string

Filter by the client type.

eventType
string

Filter by the event type.

factorNumber
string

Filter by the factor number.

sequenceNumber
string

Filter by the sequence number.

actionFlags
string

Filter by the action flags.

dgHierarchyLevel1
string

Filter by the data group hierarchy level 1.

dgHierarchyLevel2
string

Filter by the data group hierarchy level 2.

dgHierarchyLevel3
string

Filter by the data group hierarchy level 3.

dgHierarchyLevel4
string

Filter by the data group hierarchy level 4.

virtualSystemName
string

Filter by the virtual system name.

deviceName
string

Filter by the device name.

virtualSystemId
string

Filter by the virtual system ID.

authproto
string

Filter by the authentication protocol.

uuidForRule
string

Filter by the UUID for the rule.

header Parameters
X-Auth-Token
required
string

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:
X-Auth-Token
path Parameters
cell_group_id
required
string

The ID of the cell group.

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

Filter by the domain.

receiveTime
string

Filter by the receive time.

serial
string

Filter by the serial number.

type
string

Filter by the log type.

threatContentType
string

Filter by the threat content type.

configVersion
string

Filter by the configuration version.

generateTime
string

Filter by the generate time.

virtualSystem
string

Filter by the virtual system.

sourceIp
string

Filter by the source IP address.

user
string

Filter by the user.

dataSourceName
string

Filter by the data source name.

eventId
string

Filter by the event ID.

repeatCount
string

Filter by the repeat count.

timeout
string

Filter by the timeout.

beginport
string

Filter by the begin port.

endport
string

Filter by the end port.

dataSource
string

Filter by the data source.

dataSourceType
string

Filter by the data source type.

sequenceNumber
string

Filter by the sequence number.

actionFlags
string

Filter by the action flags.

dgHierarchyLevel1
string

Filter by the data group hierarchy level 1.

dgHierarchyLevel2
string

Filter by the data group hierarchy level 2.

dgHierarchyLevel3
string

Filter by the data group hierarchy level 3.

dgHierarchyLevel4
string

Filter by the data group hierarchy level 4.

virtualSystemName
string

Filter by the virtual system name.

deviceName
string

Filter by the device name.

virtualSystemId
string

Filter by the virtual system ID.

factorType
string

Filter by the factor type.

factorCompletionTime
string

Filter by the factor completion time.

factorNumber
string

Filter by the factor number.

ugflags
string

Filter by the user group flags.

userbysource
string

Filter by the user by source.

header Parameters
X-Auth-Token
required
string

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