Unknowns API Reference
| Field | Value |
|---|---|
| Source spec | unknowns/openapi/v1.json |
| OpenAPI version | 3.1.1 |
| API version | 1.0.0 |
| Operations | 27 |
| Path filter | All paths |
Operations
GET /api/grey-queue
List grey queue entries with pagination
unknowns.grey_queue.list_description
| Property | Value |
|---|---|
| Operation ID | ListGreyQueueEntries |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
reason | query | no | |
skip | query | no | |
status | query | no | |
take | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
POST /api/grey-queue
Enqueue a new grey queue entry
unknowns.grey_queue.enqueue_description
| Property | Value |
|---|---|
| Operation ID | EnqueueGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
201 | Created | application/json |
GET /api/grey-queue/by-unknown/{unknownId}
Get grey queue entry by unknown ID
unknowns.grey_queue.get_by_unknown_description
| Property | Value |
|---|---|
| Operation ID | GetGreyQueueByUnknownId |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
unknownId | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
POST /api/grey-queue/expire
Expire old entries
unknowns.grey_queue.expire_description
| Property | Value |
|---|---|
| Operation ID | ExpireGreyQueueEntries |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/ready
Get entries ready for processing
unknowns.grey_queue.ready_description
| Property | Value |
|---|---|
| Operation ID | GetReadyForProcessing |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
limit | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/summary
Get grey queue summary statistics
unknowns.grey_queue.summary_description
| Property | Value |
|---|---|
| Operation ID | GetGreyQueueSummary |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/triggers/cve/{cveId}
Get entries triggered by CVE update
unknowns.grey_queue.get_by_cve_description
| Property | Value |
|---|---|
| Operation ID | GetByCveTrigger |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
cveId | path | yes | |
limit | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/triggers/feed/{feedId}
Get entries triggered by feed update
unknowns.grey_queue.get_by_feed_description
| Property | Value |
|---|---|
| Operation ID | GetByFeedTrigger |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
feedId | path | yes | |
limit | query | no | |
version | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/triggers/tool/{toolId}
Get entries triggered by tool update
unknowns.grey_queue.get_by_tool_description
| Property | Value |
|---|---|
| Operation ID | GetByToolTrigger |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
toolId | path | yes | |
limit | query | no | |
version | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/grey-queue/{id}
Get grey queue entry by ID
unknowns.grey_queue.get_by_id_description
| Property | Value |
|---|---|
| Operation ID | GetGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/assign
Assign entry for review
unknowns.grey_queue.assign_description
| Property | Value |
|---|---|
| Operation ID | AssignGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/dismiss
Dismiss a grey queue entry
unknowns.grey_queue.dismiss_description
| Property | Value |
|---|---|
| Operation ID | DismissGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/escalate
Escalate entry to security team
unknowns.grey_queue.escalate_description
| Property | Value |
|---|---|
| Operation ID | EscalateGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/process
Mark entry as processing
unknowns.grey_queue.process_description
| Property | Value |
|---|---|
| Operation ID | StartGreyQueueProcessing |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/reject
Reject a grey queue entry
unknowns.grey_queue.reject_description
| Property | Value |
|---|---|
| Operation ID | RejectGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/reopen
Reopen a closed entry
unknowns.grey_queue.reopen_description
| Property | Value |
|---|---|
| Operation ID | ReopenGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
400 | Bad Request | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/resolve
Resolve a grey queue entry
unknowns.grey_queue.resolve_description
| Property | Value |
|---|---|
| Operation ID | ResolveGreyQueueEntry |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
POST /api/grey-queue/{id}/result
Record processing result
unknowns.grey_queue.record_result_description
| Property | Value |
|---|---|
| Operation ID | RecordGreyQueueResult |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | application/json |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
GET /api/grey-queue/{id}/transitions
Get valid state transitions
unknowns.grey_queue.transitions_description
| Property | Value |
|---|---|
| Operation ID | GetValidTransitions |
| Tags | GreyQueue |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
GET /api/unknowns
List unknowns with pagination
unknowns.unknown.list_description
| Property | Value |
|---|---|
| Operation ID | ListUnknowns |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
asOf | query | no | |
kind | query | no | |
severity | query | no | |
skip | query | no | |
take | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/unknowns/high-confidence
Get unknowns with high-confidence hints
unknowns.unknown.get_high_confidence_description
| Property | Value |
|---|---|
| Operation ID | GetHighConfidenceHints |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
limit | query | no | |
minConfidence | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/unknowns/hot-queue
Get HOT unknowns for immediate processing
unknowns.unknown.get_hot_queue_description
| Property | Value |
|---|---|
| Operation ID | GetHotQueue |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
limit | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/unknowns/summary
Get unknowns summary statistics
unknowns.unknown.summary_description
| Property | Value |
|---|---|
| Operation ID | GetUnknownsSummary |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/unknowns/triage/{band}
Get unknowns by triage band
unknowns.unknown.get_by_triage_band_description
| Property | Value |
|---|---|
| Operation ID | GetUnknownsByTriageBand |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
band | path | yes | |
limit | query | no | |
offset | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
GET /api/unknowns/{id}
Get unknown by ID
unknowns.unknown.get_by_id_description
| Property | Value |
|---|---|
| Operation ID | GetUnknownById |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
GET /api/unknowns/{id}/hints
Get provenance hints for unknown
unknowns.unknown.get_hints_description
| Property | Value |
|---|---|
| Operation ID | GetUnknownHints |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
GET /api/unknowns/{id}/history
Get bitemporal history for unknown
unknowns.unknown.get_history_description
| Property | Value |
|---|---|
| Operation ID | GetUnknownHistory |
| Tags | Unknowns |
| Auth | Not declared |
| Request body | - |
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Tenant-Id | header | yes | |
id | path | yes | |
from | query | no | |
to | query | no |
Responses:
| Status | Description | Content types |
|---|---|---|
200 | OK | application/json |
404 | Not Found | - |
