Documentation Powered by ReDoc

threatDetectionsリソースAPI (1.0)

Download OpenAPI specification:Download

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

概要

本APIでは、docomo business RINKのセキュリティサービスの回線別契約情報リストリソース情報の参照・操作が可能です。

threatDetections

脅威検知詳細一覧を取得するAPI

脅威検知詳細一覧を取得するAPI

query Parameters
limit
string

ページあたりの表示件数の指定（デフォルト10, 最大100）

offset
string

表示するページ番号の指定（デフォルト0）

terminalId
string
  • ルーターリソースのID.
  • 指定なしならテナント内のすべてのルーターリソースが検索対象
  • キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能
circuitId
string
  • 回線リソースのID
  • キーバリューペアを繰り返し指定することで複数の回線リソースを指定可能
threatLevel
string
Enum: "Critical" "High" "Medium" "Low" "Information" "Other"

脅威度のフィルタ（複数選択可）

threatType
string
Enum: "APT" "Malware" "Phishing" "C2" "Exploit" "Other"

脅威種別のフィルタ（複数選択可）

  • APT: Advanced Persistent Threat
  • Malware: マルウェア
  • Phishing: フィッシング
  • C2: Command and Control
  • Exploit: エクスプロイト
  • Other: (上記以外のthreatType)
blockingStatus
string
Enum: "blocked" "noBlocked" "unBlockable" "autoBlocked"

端末遮断ステータスのフィルタ（複数選択可）

sortKey
string

ソート項目の指定. レスポンスボディの項目から

direction
string

ソート順の指定. asc: 昇順, desc: 降順

startTime
string
  • 取得期間の開始時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含むそれ以後のタイムスタンプのデータが集計される。
  • 指定がなければ 現在時刻の24時間前。endTimeの指定があり、startTimeの指定がない場合は、endTimeの24時間前。
endTime
string
  • 取得期間の終了時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含まないそれより過去のタイムスタンプのデータが集計される。
  • 指定がなければ 現在時刻。
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

404

User Not Found

get/v1/threat-detections
https://api.ntt.com/sdpf-ztgict/v1/threat-detections

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "limit": 10,
  • "threatDetections":
    [
    ]
}

threatDetectionsFilter

CPE遮断フィルタ一覧の取得API

CPE遮断フィルタ一覧を取得するAPI

query Parameters
limit
string

ページあたりの表示件数の指定（デフォルト10, 最大1000）

offset
string

表示するページ番号の指定（デフォルト0）

terminalId
string
  • ルーターリソースのID.
  • 指定なしならテナント内のすべてのルーターリソースが検索対象
  • キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能
blockingStatus
string
  • フィルタの適用状況
  • true: フィルタ適用中
  • false: フィルタ未適用
operationStatus
string
  • blockProcessing: 遮断処理中
  • blockCompleted: 遮断完了
  • blockFailed: 遮断失敗
  • unblockProcessing: 遮断解除処理中
  • unblockCompleted: 遮断解除完了
  • unblockFailed: 遮断解除失敗
sortKey
string

ソート項目の指定. terminalId, creationTimeでソート可。

direction
string

ソート順の指定. asc: 昇順, desc: 降順

startTime
string
  • 取得期間の開始時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含むそれ以後のタイムスタンプのデータが集計される。
  • 指定がなければ 現在時刻の24時間前。endTimeの指定があり、startTimeの指定がない場合は、endTimeの24時間前。
  • 検索対象はcreationTime
endTime
string
  • 取得期間の終了時刻。ISO8601 の拡張形式 (YYYY-MM-DDThh:mm:ss+hh:mm)。この時間を含まないそれより過去のタイムスタンプのデータが集計される。
  • 指定がなければ 現在時刻。
  • 検索対象はcreationTime
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

404

User Not Found

get/v1/threat-detection-filters
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-filters

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "limit": 10,
  • "filters":
    [
    ]
}

CPE遮断リソース変更API

脅威検知情報からCPEの遮断用のリソースを作成するAPI

path Parameters
terminalId
required
string
  • ルーターリソースのID.
  • 特定のterminalIdの脅威検知フィルタを取得するAPI
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
  • 脅威検知情報からCPEの遮断用のリソースを作成するAPI
  • filtersに指定したフィルタで上書きされる
filters
required
Array of objects

脅威検知フィルタのリスト

  • 複数のフィルタを指定することができる
  • 1つのフィルタは、threatDestination, sourceIp, destinationPort, sourcePort, protocolを指定する

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/threat-detection-filters/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-filters/{terminalId}

Request samples

Content type
application/json
Example
CPEフィルタ作成
Copy
 Expand all Collapse all
{
  • "filters":
    [
    ]
}

Response samples

Content type
application/json
Example
CPEフィルタ作成
Copy
 Expand all Collapse all
{
  • "filters":
    [
    ]
}

脅威検知詳細を削除するAPI

CPE遮断フィルタのリソースを削除するAPI

  • 残っているfilterがあれば、responseで返却される
path Parameters
terminalId
required
string
  • ルーターリソースのID.
  • 特定のterminalIdの脅威検知フィルタを取得するAPI
header Parameters
X-Auth-Token
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
filterIds
required
Array of strings

削除するfilterIdのリスト

  • 複数のfilterIdを指定することができる

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

User Not Found

500

Internal Server Error

delete/v1/threat-detection-filters/{terminalId}
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-filters/{terminalId}

Request samples

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

Response samples

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