脅威検知 API (1.0)

Download OpenAPI specification:Download

概要

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

ThreatDetections

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

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

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

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

offset
integer >= 0
Default: 0

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

terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789
  • ルーターリソースのID(Z番)
  • 指定なしならテナント内のすべてのルーターリソースが検索対象
  • キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能
sharedTenantId
string ^[0-9a-f]{32}$
Example: sharedTenantId=550e8400e29b41d4a716446655440000
  • 脅威検知情報を共有しているテナントIDで検索
  • 指定したテナントIDと共有している脅威検知情報が検索対象
  • 指定がなければ、自身のテナントの脅威検知情報のみを取得
  • キーバリューペアを繰り返し指定することで複数のテナントIDを指定可能
circuitId
string ^[ZV][0-9]{9}$
Example: circuitId=Z123456789
  • 回線リソースのID(回線のZ番)
  • 単独指定可。terminalId と組み合わせた AND 絞り込みも可能
  • キーバリューペアを繰り返し指定することで複数の回線リソースを指定可能
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"

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

trafficDirection
string
Enum: "in" "out"
  • 通信方向のフィルタ
  • in: 下り
  • out: 上り
detectionType
string
Enum: "ipAddress" "domain" "signature"
  • 脅威検知カテゴリのフィルタ
  • ipAddress: IPアドレス検知
  • domain: ドメイン検知
  • signature: シグネチャ検知
sortKey
string
Default: "timestamp"
Enum: "terminalId" "circuitId" "circuitPriority" "detectionType" "blockingStatus" "timestamp" "threatType" "threatLevel" "threatDestination" "threatPort" "applicationCategory" "direction" "destinationIp" "sourceIp" "destinationPort" "sourcePort" "protocol" "lineType"

ソート項目の指定. レスポンスボディの項目から(デフォルト timestamp)

direction
string
Default: "asc"
Enum: "asc" "desc"

ソート順の指定. asc: 昇順, desc: 降順(デフォルト asc)

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

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

ThreatDetectionFilters

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

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

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 10

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

offset
integer >= 0
Default: 0

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

terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789
  • ルーターリソースのID(Z番)
  • 遮断フィルタはルーター専用のため terminal 種別の Z 番のみ指定可能
  • 指定なしならテナント内のすべてのルーターリソースが対象
  • キーバリューペアを繰り返し指定することで複数のルーターリソースを指定可能
blockingStatus
string
Enum: "true" "false"
  • フィルタの適用状況
  • true: フィルタ適用中
  • false: フィルタ未適用
operationStatus
string
Enum: "blockProcessing" "blockCompleted" "blockFailed" "unblockProcessing" "unblockCompleted" "unblockFailed"
  • blockProcessing: 遮断処理中
  • blockCompleted: 遮断完了
  • blockFailed: 遮断失敗
  • unblockProcessing: 遮断解除処理中
  • unblockCompleted: 遮断解除完了
  • unblockFailed: 遮断解除失敗
sortKey
string
Enum: "terminalId" "creationTime"

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

direction
string
Default: "asc"
Enum: "asc" "desc"

ソート順の指定. asc: 昇順, desc: 降順(デフォルト asc)

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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

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

path Parameters
terminalId
required
string ^Z[0-9]{9}$
Example: Z123456789
  • ルーターリソースのID(Z番)
  • 遮断フィルタはルーター専用のため terminal 種別の Z 番を指定する
header Parameters
X-Auth-Token
required
string

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

Request Body schema: application/json
  • 脅威検知情報からルーターの遮断用のリソースを作成する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
Copy
Expand all Collapse all
{
  • "filters":
    [
    ]
}

Response samples

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

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

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

  • 残っているfilterがあれば、responseで返却される
path Parameters
terminalId
required
string ^Z[0-9]{9}$
Example: Z123456789
  • ルーターリソースのID(Z番)
  • 遮断フィルタはルーター専用のため terminal 種別の Z 番を指定する
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

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

ThreatDetectionShareds

共有リクエストの一覧を確認するAPI

脅威情報共有のリクエストおよび共有停止リクエストの一覧を取得するAPI

  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • 共有開始時には該当ルーターにて脅威検知オプションの申込が必要
  • 脅威検知オプションの利用を停止しても脅威情報共有の利用は廃止されないため、共有を停止する場合は共有停止リクエストの作成が必要
  • レスポンスのルーター情報等は、最新情報ではなくリクエスト作成時点のスナップショットを返却する
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

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

offset
integer >= 0
Default: 0

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

requestId
Array of strings
Example: requestId=62ec2b62646740b5809f695dea7b2bbf

リクエストIDで絞り込むためのクエリパラメータ

  • 複数選択可。キーバリューペアを繰り返し指定する (例: ?requestId=<id1>&requestId=<id2>)
  • 複数指定した場合は OR 条件で絞り込む
sharedTenantId
Array of strings
Example: sharedTenantId=550e8400e29b41d4a716446655440000

共有先テナントIDで絞り込むためのクエリパラメータ

  • 指定した場合は該当テナントのみを返却する
  • 複数選択可。キーバリューペアを繰り返し指定する (例: ?sharedTenantId=<id1>&sharedTenantId=<id2>)
  • 複数指定した場合は OR 条件で絞り込む
requestDirection
string
Enum: "sent" "received"

共有リクエストの方向でフィルタリングするためのクエリパラメータ

  • sent: 自テナントが送信したリクエスト
  • received: 自テナントが受領したリクエスト
status
string
Enum: "pendingApproval" "approved" "rejected" "cancelled"
  • ステータスでフィルタリングするためのクエリパラメータ
  • 指定されたステータスに紐づく共有リクエストと共有停止リクエストのみがレスポンスに含まれる
requestType
string
Enum: "threatDetectionShareRequest" "threatDetectionStopShareRequest"
  • リクエストタイプでフィルタリングするためのクエリパラメータ
  • 指定されたリクエストタイプに紐づく共有リクエストまたは共有停止リクエストのみがレスポンスに含まれる
sortKey
string
Enum: "creationTime" "updateTime" "requestType" "status"

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

direction
string
Enum: "asc" "desc"

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

  • sortKey とセットで指定する必要がある。direction のみを単独指定した場合は 400 エラーとなる
  • sortKey を指定して direction を省略した場合は desc となる
header Parameters
X-Auth-Token
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

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

脅威情報共有の開始リクエストまたは共有停止リクエストを作成するAPI

脅威情報共有の開始リクエストまたは共有停止リクエストを作成するAPI

  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • 共有開始リクエスト作成時の共有対象のルーターは脅威検知オプションが申込済みであることが必要
  • ルーター自体が inactive の状態でも共有開始は可能
  • 共有開始リクエストでは /v1/settings/tenant-reference-auth-key で発行した key の指定が必要
  • 共有開始リクエストの sharedTenantId は key が参照する tenantId と一致している必要がある
  • 共有開始リクエストで使用した key は使用済みとなり、以降は同一の key の使用は不可
  • すでに共有中のテナントへの共有開始リクエストは billingMethod が同じ種別になっていない場合はエラーになる
  • 共有停止リクエストでは key は不要
  • 共有停止リクエストは作成時に即時承認され、status は approved になるため、キャンセル不可
  • レスポンスのルーター情報等は、最新情報ではなくリクエスト作成時点のスナップショットを返却する
header Parameters
X-Auth-Token
required
string

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

Request Body schema: application/json
key
required
string ^[a-f0-9]{64}$

/v1/settings/tenant-reference-auth-key で発行した認証キー

  • key が参照する tenantId と sharedTenantId は一致している必要がある
  • category が threatDetectionShared として発行された key のみ利用可能
  • 共有開始リクエストで使用すると使用済みとなり、以降は同一の key の使用は不可
sharedTenantId
required
string ^[0-9a-f]{32}$

共有先テナントID. UUID 形式

terminalIds
required
Array of strings non-empty

提供するルーターリソースID一覧

  • 1件以上を指定する
  • 同一の terminalId を重複して指定できない
billingMethod
required
string (BillingMethod)
Enum: "receiverPays" "providerPays" "split"

課金方式

  • receiverPays: 脅威情報の受領側負担
  • providerPays: 脅威情報の提供側負担
  • split: 脅威情報の受領側・提供側で折半

すでに共有中のテナントへの共有開始リクエストは billingMethod が同じ種別になっていない場合はエラーになる

requestType
required
string

共有リクエスト作成

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/threat-detection-shared/requests
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-shared/requests

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "key": "8bc6067665165e13204863b1a38293b18aa1110f296698b891a6a19e9e262ca4",
  • "sharedTenantId": "550e8400e29b41d4a716446655440000",
  • "terminalIds":
    [
    ],
  • "billingMethod": "receiverPays",
  • "requestType": "threatDetectionShareRequest"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ref": "/v1/threat-detection-shared/requests/62ec2b62646740b5809f695dea7b2bbf",
  • "requestDirection": "sent",
  • "status": "pendingApproval",
  • "requestType": "threatDetectionShareRequest",
  • "creationTime": "2026-03-23T10:05:48+09:00",
  • "updateTime": "2026-03-23T10:05:48+09:00",
  • "sharedTenantId": "550e8400e29b41d4a716446655440000",
  • "contractorName": "NTTドコモビジネス株式会社",
  • "terminals":
    [
    ],
  • "billingMethod": "receiverPays"
}

共有リクエストの詳細を確認するAPI

共有リクエストまたは共有停止リクエストの詳細を取得するAPI

  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • レスポンスのルーター情報等は、最新情報ではなくリクエスト作成時点のスナップショットを返却する
path Parameters
requestId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

脅威検知共有リクエストID. UUID 形式

header Parameters
X-Auth-Token
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/threat-detection-shared/requests/{requestId}
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-shared/requests/{requestId}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ref": "/v1/threat-detection-shared/requests/62ec2b62646740b5809f695dea7b2bbf",
  • "requestDirection": "sent",
  • "status": "pendingApproval",
  • "requestType": "threatDetectionShareRequest",
  • "creationTime": "2026-03-23T10:05:48+09:00",
  • "updateTime": "2026-03-23T10:05:48+09:00",
  • "sharedTenantId": "550e8400e29b41d4a716446655440000",
  • "contractorName": "NTTドコモビジネス株式会社",
  • "terminals":
    [
    ],
  • "billingMethod": "receiverPays"
}

共有リクエストをキャンセルするAPI

共有リクエストまたは共有停止リクエストをキャンセルするAPI

  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • 共有停止リクエストは作成時に即時承認されるため、キャンセル不可
  • レスポンスのルーター情報等は、最新情報ではなくリクエスト作成時点のスナップショットを返却する
path Parameters
requestId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

脅威検知共有リクエストID. UUID 形式

header Parameters
X-Auth-Token
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/threat-detection-shared/requests/{requestId}
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-shared/requests/{requestId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ref": "/v1/threat-detection-shared/requests/62ec2b62646740b5809f695dea7b2bbf",
  • "requestDirection": "sent",
  • "status": "cancelled",
  • "requestType": "threatDetectionShareRequest",
  • "creationTime": "2026-03-23T10:05:48+09:00",
  • "updateTime": "2026-03-23T11:05:48+09:00",
  • "sharedTenantId": "550e8400e29b41d4a716446655440000",
  • "contractorName": "NTTドコモビジネス株式会社",
  • "terminals":
    [
    ],
  • "billingMethod": "receiverPays"
}

共有リクエストを更新するAPI

共有リクエストまたは共有停止リクエストに対して承認または否認を行うAPI

  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • レスポンスのルーター情報等は、最新情報ではなくリクエスト作成時点のスナップショットを返却する
path Parameters
requestId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

脅威検知共有リクエストID. UUID 形式

header Parameters
X-Auth-Token
required
string

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

Request Body schema: application/json
action
required
string (ThreatDetectionSharedAction)
Enum: "approve" "reject"

受領したリクエストに対するアクション

  • approve: 承認
  • reject: 否認

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

put/v1/threat-detection-shared/requests/{requestId}
https://api.ntt.com/sdpf-ztgict/v1/threat-detection-shared/requests/{requestId}

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "action": "approve"
}

Response samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestId": "62ec2b62646740b5809f695dea7b2bbf",
  • "ref": "/v1/threat-detection-shared/requests/62ec2b62646740b5809f695dea7b2bbf",
  • "requestDirection": "received",
  • "status": "approved",
  • "requestType": "threatDetectionShareRequest",
  • "creationTime": "2026-03-23T10:05:48+09:00",
  • "updateTime": "2026-03-23T12:05:48+09:00",
  • "sharedTenantId": "550e8400e29b41d4a716446655440000",
  • "contractorName": "NTTドコモビジネス株式会社",
  • "terminals":
    [
    ],
  • "billingMethod": "receiverPays"
}

共有中ルーターの一覧を確認するAPI

脅威情報共有の共有中ルーター一覧を取得するAPI

  • レスポンスは共有中ルーター (terminalId) 単位のフラットな一覧で、各要素に共有先テナント (sharedTenantId / contractorName)・共有方向 (terminalDirection)・課金方式 (billingMethod) を含む
  • total / offset / limit によりルーター件数単位でページネーションできる
  • terminalDirection は所有関係で一意に決まる (自テナントのルーター=provided, 他テナントのルーター=received)。同一 terminalId が provided と received の両方に現れることはない
  • provided は同一 terminalId を複数テナントに共有している場合、共有先テナントごとに複数行返却される (行の一意キーは sharedTenantId + terminalId)
  • 脅威情報共有の利用には WANセキュリティ機能利用に関する同意設定に同意済みであること(GET /v1/settings/security のレスポンスが "termsOfServiceAccepted": true)が必要
  • sharedTenantId を指定した場合は、該当する共有先テナントのルーターのみを取得する
  • terminalDirection を指定した場合は、提供ルーターまたは受領ルーターのどちらか一方のみを取得する
query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

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

offset
integer >= 0
Default: 0

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

sharedTenantId
string ^[0-9a-f]{32}$
Example: sharedTenantId=550e8400e29b41d4a716446655440000

共有先テナントIDで絞り込むためのクエリパラメータ

  • 指定した場合は該当テナントのみを返却する
  • 自テナントのIDを指定した場合は 400 エラーとなる
  • 指定できるのは 1 件のみ
terminalDirection
string (ThreatDetectionSharedTerminalDirection)
Enum: "provided" "received"
Example: terminalDirection=provided

取得する共有中ルーター一覧の方向を指定する

  • provided: 提供ルーター一覧のみを返却する
  • received: 受領ルーター一覧のみを返却する
terminalId
string ^Z[0-9]{9}$
Example: terminalId=Z123456789

共有中のルーターIDで絞り込むためのクエリパラメータ

  • 指定した場合は該当ルーターのみを返却する
  • 指定できるのは 1 件のみ
sortKey
string
Value: "approvalTime"

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

direction
string
Enum: "asc" "desc"

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

  • sortKey を指定しない場合、direction の指定は無視される
  • sortKey を指定して direction を省略した場合は desc となる
header Parameters
X-Auth-Token
required
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

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

Response samples

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