脅威検知 API (1.0)
Download OpenAPI specification:Download
脅威検知詳細一覧を取得する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
|
| sharedTenantId | string ^[0-9a-f]{32}$ Example: sharedTenantId=550e8400e29b41d4a716446655440000
|
| circuitId | string ^[ZV][0-9]{9}$ Example: circuitId=Z123456789
|
| threatLevel | string Enum: "Critical" "High" "Medium" "Low" "Information" "Other" 脅威度のフィルタ(複数選択可) |
| threatType | string Enum: "APT" "Malware" "Phishing" "C2" "Exploit" "Other" 脅威種別のフィルタ(複数選択可)
|
| blockingStatus | string Enum: "blocked" "noBlocked" "unBlockable" "autoBlocked" 端末遮断ステータスのフィルタ(複数選択可) |
| trafficDirection | string Enum: "in" "out"
|
| detectionType | string Enum: "ipAddress" "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
|
| endTime | string <date-time> Example: endTime=2026-03-23T10:05:48+09:00
|
header Parameters
| X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "total": 100,
- "offset": 0,
- "limit": 10,
- "threatDetections": [
- {
- "sharedTenantId": "550e8400e29b41d4a716446655440000",
- "terminalId": "Z123456789",
- "customerNote": "東京支店ルーター",
- "circuitId": "Z123456789",
- "circuitType": "ipoe",
- "circuitPriority": "main",
- "detectionType": "ipAddress",
- "blockingStatus": "blocked",
- "timestamp": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "threatType": "Malware",
- "threatLevel": "High",
- "threatDestination": "192.0.2.1",
- "threatPort": 80,
- "applicationCategory": "web-browsing",
- "direction": "in",
- "destinationIp": "192.0.2.1",
- "sourceIp": "192.0.2.1",
- "destinationPort": 80,
- "sourcePort": 12345,
- "protocol": "tcp",
- "lineType": "internet"
}
]
}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
|
| blockingStatus | string Enum: "true" "false"
|
| operationStatus | string Enum: "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
|
| endTime | string
|
header Parameters
| X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Response samples
- 200
{- "total": 100,
- "offset": 0,
- "limit": 10,
- "filters": [
- {
- "filterId": "550e8400e29b41d4a716446655440000",
- "terminalId": "Z123456789",
- "creationTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "endTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "blockingStatus": true,
- "operationStatus": "blockProcessing",
- "latestGetCounterTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "latestFilterHitCount": "11",
- "previousGetCounterTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "previousFilterHitCount": "10",
- "threatDestination": "192.0.2.1/32",
- "sourceIp": "0.0.0.0/0",
- "destinationPort": "any",
- "sourcePort": "any",
- "protocol": "any"
}
]
}CPE遮断リソース変更API
脅威検知情報からルーターの遮断用のリソースを作成するAPI
path Parameters
| terminalId required | string ^Z[0-9]{9}$ Example: Z123456789
|
header Parameters
| X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
- 脅威検知情報からルーターの遮断用のリソースを作成するAPI
- filtersに指定したフィルタで上書きされる
| filters required | Array of objects 脅威検知フィルタのリスト
|
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "filters": [
- {
- "threatDestination": "192.0.2.1/32",
- "sourceIp": "0.0.0.0/0",
- "destinationPort": "any",
- "sourcePort": "any",
- "protocol": "any"
}
]
}Response samples
- 202
{- "filters": [
- {
- "filterId": "550e8400e29b41d4a716446655440000",
- "terminalId": "Z123456789",
- "creationTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "endTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "blockingStatus": true,
- "operationStatus": "blockProcessing",
- "latestGetCounterTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "latestFilterHitCount": "11",
- "previousGetCounterTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "previousFilterHitCount": "10",
- "threatDestination": "192.0.2.1/32",
- "sourceIp": "0.0.0.0/0",
- "destinationPort": "any",
- "sourcePort": "any",
- "protocol": "any"
}
]
}脅威検知詳細を削除するAPI
ルーター遮断フィルタのリソースを削除するAPI
- 残っているfilterがあれば、responseで返却される
path Parameters
| terminalId required | string ^Z[0-9]{9}$ Example: Z123456789
|
header Parameters
| X-Auth-Token required | string クライアントが Keystone を利用して取得した認証 Token |
Request Body schema: application/json
| filterIds required | Array of strings 削除するfilterIdのリスト
|
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Request samples
- Payload
{- "filterIds": [
- "550e8400e29b41d4a716446655440000",
- "550e8400e29b41d4a716446655440001"
]
}Response samples
- 202
{- "filters": [
- {
- "filterId": "550e8400e29b41d4a716446655440000",
- "terminalId": "Z123456789",
- "creationTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "endTime": "YYYY-MM-DDThh:mm:ss+hh:mm",
- "blockingStatus": false,
- "operationStatus": "unblockProcessing",
- "threatDestination": "192.0.2.1/32",
- "sourceIp": "0.0.0.0/0",
- "destinationPort": "any",
- "sourcePort": "any",
- "protocol": "any"
}
]
}