docomo business SIGN セキュリティ機能 APIリファレンス (1.1.0)

Download OpenAPI specification:Download

docomo business SIGN セキュリティ機能 APIリファレンス

脅威検知

脅威検知の設定を行うAPI

脅威検知概要(その他)の取得

脅威検知概要(その他)の取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date-time> Example: from=2025-12-01T10:50:25Z 検索年月日時分秒(from)　検索年月日時分秒(to)以前であること。
to required	string <date-time> Example: to=2025-12-02T10:50:25Z 検索年月日時分秒(to)　検索年月日時分秒(from)以降であること。
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
simId	string Example: simId=440130000096015 回線ID（部分一致）
threatSeverity	string Enum: "critical" "high" "medium" "other" "low" "informational" 脅威度（複数指定可能）
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"threatSummaries": [{"receiveTime": "2021-08-01T00:00:00.000Z",
"recordCount": 5,
"simId": "440130000096015",
"profileStatus": "inactive",
"detectedTarget": "ccdn.microsoftdocs.workers.dev",
"threatSeverity": "critical",
"threatType": "spyware",
"simName": "string",
"isLocked": true
}
],
"total": 0,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

脅威検知詳細(その他)の取得

脅威検知詳細(その他)の取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date-time> Example: from=2025-12-01T10:50:25Z 検索年月日時分秒(from)　検索年月日時分秒(to)以前であること。
to required	string <date-time> Example: to=2025-12-02T10:50:25Z 検索年月日時分秒(to)　検索年月日時分秒(from)以降であること。
simId required	string Example: simId=440130000096015 回線ID
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"threats": [{"receiveTime": "2021-08-01T00:00:00.000Z",
"threatSeverity": "critical",
"threatType": "spyware",
"detectedTarget": "ccdn.microsoftdocs.workers.dev",
"application": "dns-base",
"ipProtocol": "udp",
"stream": "DOWN",
"sourceAddress": "192.168.11.2",
"destinationAddress": "20.24.249.45",
"sourcePort": "9215",
"destinationPort": "53",
"lineType": "INT"
}
],
"total": 0,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

脅威検知概要(IP)の取得

脅威検知概要(IP)の取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date-time> Example: from=2025-12-01T10:50:25Z 検索年月日時分秒(from)　検索年月日時分秒(to)以前であること。
to required	string <date-time> Example: to=2025-12-02T10:50:25Z 検索年月日時分秒(to)　検索年月日時分秒(from)以降であること。
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
threatSeverity	string Enum: "critical" "high" "other" 脅威度（複数指定可能）
simId	string Example: simId=440130000096015 回線ID（部分一致）
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"trafficSummaries": [{"receiveTime": "2021-08-01T00:00:00.000Z",
"recordCount": 5,
"simId": "440130000096015",
"profileStatus": "inactive",
"detectedTarget": "192.168.11.2/117.219.34.162",
"threatSeverity": "critical",
"threatType": "spyware",
"simName": "string",
"isLocked": true
}
],
"total": 0,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

脅威検知詳細(IP)の取得

脅威検知詳細(IP)の取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date-time> Example: from=2025-12-01T10:50:25Z 検索年月日時分秒(from)　検索年月日時分秒(to)以前であること。
to required	string <date-time> Example: to=2025-12-02T10:50:25Z 検索年月日時分秒(to)　検索年月日時分秒(from)以降であること。
simId required	string Example: simId=440130000096015 回線ID
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"traffics": [{"receiveTime": "2021-08-01T00:00:00.000Z",
"threatSeverity": "critical",
"threatType": "spyware",
"detectedTarget": "192.168.11.2/117.219.34.162",
"application": "dns-base",
"ipProtocol": "udp",
"stream": "DOWN",
"sourceAddress": "192.168.11.2",
"destinationAddress": "20.24.249.45",
"sourcePort": "9215",
"destinationPort": "53",
"lineType": "INT"
}
],
"total": 0,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

フローコレクター

フローコレクター関連のAPI

通信ログの取得

通信ログの取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

from required	string <date> Example: from=2024-06-10 検索年月日(from)　検索年月日(to)以前であること。 fromパラメータに指定された日付の午前0時00分00秒以降のデータを取得対象とします。
to required	string <date> Example: to=2024-06-10 検索年月日(to)　検索年月日(from)以降であること。 toパラメータに指定された日付の23時59分59秒までのデータを取得対象とします。
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
simId	string Example: simId=440130000096015 回線ID（部分一致）
ipv4SrcAddr	string <ipv4> Example: ipv4SrcAddr=192.168.1.89 送信元IPアドレス
ipv4DstAddr	string <ipv4> Example: ipv4DstAddr=10.0.1.2 宛先IPアドレス
l4SrcPort	integer Example: l4SrcPort=54321 送信元Port
l4DstPort	integer Example: l4DstPort=443 宛先Port
appId	integer Example: appId=218104303 NBARアプリケーションID
protocol	integer Example: protocol=8 IPプロトコル番号
page	integer >= 1 Example: page=3 ページ数. デフォルトは1
pageSize	integer [ 1 .. 10000 ] Example: pageSize=30 1ページ中のアイテム数. デフォルトは20

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"flowCollectors": [{"flowStartMilliseconds": "2021-08-01T00:00:00.000Z",
"flowEndMilliseconds": "2021-08-05T00:00:00.000Z",
"ipv4SrcAddr": "192.168.1.89",
"ipv4DstAddr": "10.0.1.2",
"appId": "218104303",
"l4SrcPort": 54321,
"l4DstPort": 443,
"protocol": 8,
"inBytes": 2000,
"inPkts": 50,
"simId": "440130000096015"
}
],
"total": 0,
"totalPages": 5,
"page": 1,
"pageSize": 20
}

通信ログの時系列トラフィック量推移取得

通信ログの時系列トラフィック量推移を取得します。
baseDateTimeを基準にperiodで指定した期間のトラフィック量を取得します。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
baseDateTime required	date-timeISO8601形式(タイムゾーン指定) Example: baseDateTime=2025-12-01T10:50:25Z 検索基準時刻。
period required	string Enum: "15m" "1h" "24h" "7d" Example: period=1m 検索期間。
interval required	string Enum: "1m" "5m" "15m" "30m" "1h" "2h" "1d" Example: interval=1m 集計を行う単位時間 periodが15mの場合: interval = 1m を指定 periodが1hの場合: interval = 5m を指定 periodが24hの場合: interval = 1h を指定 periodが7dの場合: interval = 1d を指定
rankBy required	string Enum: "src_ip" "dst_ip" "src_port" "dst_port" "src_ip_port" "dst_ip_port" "protocol" "app_id" Example: rankBy=src_ip 集計対象 src_ip: 送信元IPアドレス dst_ip: 送信先IPアドレス src_port: 送信元Port dst_port: 送信先Port src_ip_port: 送信元IPアドレスと送信元Port dst_ip_port: 送信先IPアドレスと送信先Port protocol: プロトコル app_id: アプリケーションID
top	integer [ 1 .. 100 ] Default: 10 Example: top=10 上位何件を取得するか
app_id	string Example: app_id=218104303 集計対象のアプリケーションID
src_ip	string Example: src_ip=192.168.0.1 集計対象の送信元IP(複数指定可能)
src_port	integer Example: src_port=1000 集計対象の送信元Port(複数指定可能)
src_nw_address	ipv4 Example: src_nw_address=192.168.0.0/24 集計対象の送信元ネットワークアドレス(複数指定可能)
dst_ip	string Example: dst_ip=192.168.0.1 集計対象の送信先IP(複数指定可能)
dst_port	integer Example: dst_port=1000 集計対象の送信先Port(複数指定可能)
dst_nw_address	ipv4 Example: dst_nw_address=192.168.0.0/24 集計対象の送信先ネットワークアドレス(複数指定可能)
protocol	integer Example: protocol=6 集計対象のプロトコル番号(複数指定可能) 0-255の範囲で指定

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400
404

Content type

application/json

{"cacheHit": true,
"totalBytesProcessed": 1000000,
"traffics": [{"group": "192.168.0.1",
"rank": 1,
"rates": [{"bps": 1000.01,
"pps": 1000.02,
"timestamp": "2025-12-01T10:50:25Z"
}
]
}
]
}

通信ログのトラフィック量ランキング

通信ログの指定期間における単位時間あたりトラフィック（bps）の平均、最大値を取得します。
baseDateTimeを基準にperiodで指定した期間のトラフィック量を取得します。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
baseDateTime required	date-timeISO8601形式(タイムゾーン指定) Example: baseDateTime=2025-12-01T10:50:25Z 検索基準時刻。
period required	string Enum: "15m" "1h" "24h" "7d" Example: period=1m 検索期間。
interval required	string Enum: "1m" "5m" "15m" "30m" "1h" "2h" "1d" Example: interval=1m 集計を行う単位時間 periodが15mの場合: interval = 1m を指定 periodが1hの場合: interval = 5m を指定 periodが24hの場合: interval = 1h を指定 periodが7dの場合: interval = 1d を指定
rankBy required	string Enum: "src_ip" "dst_ip" "src_port" "dst_port" "src_ip_port" "dst_ip_port" "protocol" "app_id" Example: rankBy=src_ip 集計対象 src_ip: 送信元IPアドレス dst_ip: 送信先IPアドレス src_port: 送信元Port dst_port: 送信先Port src_ip_port: 送信元IPアドレスと送信元Port dst_ip_port: 送信先IPアドレスと送信先Port protocol: プロトコル app_id: アプリケーションID
top	integer [ 1 .. 100 ] Default: 10 Example: top=10 上位何件を取得するか
app_id	string Example: app_id=218104303 集計対象のアプリケーションID
src_ip	string Example: src_ip=192.168.0.1 集計対象の送信元IP(複数指定可能)
src_port	integer Example: src_port=1000 集計対象の送信元Port(複数指定可能)
src_nw_address	ipv4 Example: src_nw_address=192.168.0.0/24 集計対象の送信元ネットワークアドレス(複数指定可能)
dst_ip	string Example: dst_ip=192.168.0.1 集計対象の送信先IP(複数指定可能)
dst_port	integer Example: dst_port=1000 集計対象の送信先Port(複数指定可能)
dst_nw_address	ipv4 Example: dst_nw_address=192.168.0.0/24 集計対象の送信先ネットワークアドレス(複数指定可能)
protocol	integer Example: protocol=6 集計対象のプロトコル番号(複数指定可能) 0-255の範囲で指定

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400
404

Content type

application/json

{"cacheHit": true,
"totalBytesProcessed": 1000000,
"trafficStatistics": [{"group": "192.168.0.1",
"curValue": 2933.3,
"avgValue": 2212.1,
"maxValue": 3733.2,
"rank": 1
}
]
}

通信ログの総トラフィック量取得

通信ログの指定期間からの総トラフィック量を取得します。
baseDateTimeを基準にperiodで指定した期間のトラフィック量の合計を取得します。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

lineType required	string Enum: "INT" "VPN" "MEC" 回線種別
baseDateTime required	date-timeISO8601形式(タイムゾーン指定) Example: baseDateTime=2025-12-01T10:50:25Z 検索基準時刻。
period required	string Enum: "15m" "1h" "24h" "7d" Example: period=1m 検索期間。
interval required	string Enum: "1m" "5m" "15m" "30m" "1h" "2h" "1d" Example: interval=1m 集計を行う単位時間 periodが15mの場合: interval = 1m を指定 periodが1hの場合: interval = 5m を指定 periodが24hの場合: interval = 1h を指定 periodが7dの場合: interval = 1d を指定
rankBy required	string Enum: "src_ip" "dst_ip" "src_port" "dst_port" "src_ip_port" "dst_ip_port" "protocol" "app_id" Example: rankBy=src_ip 集計対象 src_ip: 送信元IPアドレス dst_ip: 送信先IPアドレス src_port: 送信元Port dst_port: 送信先Port src_ip_port: 送信元IPアドレスと送信元Port dst_ip_port: 送信先IPアドレスと送信先Port protocol: プロトコル app_id: アプリケーションID
top	integer [ 1 .. 100 ] Default: 10 Example: top=10 上位何件を取得するか
app_id	string Example: app_id=218104303 集計対象のアプリケーションID
src_ip	string Example: src_ip=192.168.0.1 集計対象の送信元IP(複数指定可能)
src_port	integer Example: src_port=1000 集計対象の送信元Port(複数指定可能)
src_nw_address	ipv4 Example: src_nw_address=192.168.0.0/24 集計対象の送信元ネットワークアドレス(複数指定可能)
dst_ip	string Example: dst_ip=192.168.0.1 集計対象の送信先IP(複数指定可能)
dst_port	integer Example: dst_port=1000 集計対象の送信先Port(複数指定可能)
dst_nw_address	ipv4 Example: dst_nw_address=192.168.0.0/24 集計対象の送信先ネットワークアドレス(複数指定可能)
protocol	integer Example: protocol=6 集計対象のプロトコル番号(複数指定可能) 0-255の範囲で指定

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400
404

Content type

application/json

{"totalTraffic": 1000000,
"peakTraffic": 1000000
}

通信ログの保管期間設定

通信ログの保管期間設定を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

lineType	string (lineType) Enum: "mvno" "mno" 回線タイプ指定のない場合は "mvno"
flow required	boolean true: フローコレクターへトラフィックを転送する、false: フローコレクターへトラフィックを転送しない
period	integer Enum: 92 184 366 データ保存期間 flow=true の場合のみ設定

Responses

Request samples

Payload

Content type

application/json

{"lineType": "mvno",
"flow": true,
"period": 92
}

Response samples

202
400
409

Content type

application/json

{"flow": true,
"period": 92
}

通信ログの保管期間取得

通信ログの保管期間取得を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters

lineType

string (lineType)

Enum: "mvno" "mno"

回線タイプ
指定のない場合は "mvno"

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"flow": true,
"period": 92
}

ヘルプデスク設定

ヘルプデスク設定を行うAPI

ヘルプデスク機能開始API

ヘルプデスク機能の契約を行います。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json

enabled

required

boolean

true: 契約中、false: 未契約

Responses

Request samples

Payload

Content type

application/json

{"enabled": true
}

Response samples

202
400
409

Content type

application/json

{"enabled": true,
"startAt": "2024-06-10T06:30:30Z"
}

ヘルプデスク機能取得API

ヘルプデスク契約の有無を取得します。

path Parameters

tenantId

required

string = 32 characters 0-9a-f

Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters

X-Auth-Token

required

string = 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

200
400

Content type

application/json

{"enabled": true,
"startAt": "2024-06-10T06:30:30Z"
}