docomo business SIGN セキュリティ機能 APIリファレンス (1.0.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> 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（部分一致）
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

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/threat-summaries

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/threat-summaries

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"threatSummaries": 
[
{"receiveTime": "2021-08-01T00:00:00.000Z",
"recordCount": 5,
"simId": "440130000096015",
"profileStatus": "inactive",
"detectedTarget": "ccdn.microsoftdocs.workers.dev",
"threatSeverity": "critical",
"threatType": "spyware"
}
],
"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> 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秒までのデータを取得対象とします。
simId required	string Example: simId=440130000096015 回線ID
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/threats

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/threats

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}

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

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

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" 回線種別
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

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/traffic-summaries

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/traffic-summaries

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
],
"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> 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秒までのデータを取得対象とします。
simId required	string Example: simId=440130000096015 回線ID
lineType required	string Enum: "INT" "VPN" "MEC" 回線種別

header Parameters

X-Auth-Token

required

string 32 characters 0-9a-f

Example: 098e5cb2b91c4b63a64e47dfe17a5f76

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

Responses

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/traffics

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/traffics

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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"
}
]
}

フローコレクター

フローコレクター関連の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

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/flow-collectors

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/flow-collectors

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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
}

通信ログの保管期間設定

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

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

flow required	boolean true: フローコレクターへトラフィックを転送する、false: フローコレクターへトラフィックを転送しない
period	integer Enum: 92 184 366 データ保存期間 flow=true の場合のみ設定

Responses

202

Accepted.

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/security/flow-collectors/setting

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/flow-collectors/setting

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

通信ログの保管期間取得

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

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

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/flow-collectors/setting

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/flow-collectors/setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

202

Accepted.

400

Bad Request

409

Conflict

500

Internal Server Error

put/tenants/{tenantId}/security/help-desk/setting

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/help-desk/setting

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"enabled": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

200

OK.

400

Bad Request

500

Internal Server Error

get/tenants/{tenantId}/security/help-desk/setting

https://api.ntt.com/sdpf-iot-pf/v1/tenants/{tenantId}/security/help-desk/setting

Response samples

Content type

application/json

Copy

Expand all Collapse all


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