Threat Hunting

Update Job Status

Transition a threat hunt job through its lifecycle (started, completed, failed) with optional outcome details.

post/v1/hunting/jobs/{id}/status

Request

  • Base URL
    https://api.recordedfuture.com/autonomous-threat-operations
  • URL
    https://api.recordedfuture.com/autonomous-threat-operations/v1/hunting/jobs/{id}/status
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Path parameters

idstring uuid required

Threat Hunt Job ID

Request body

status'started' | 'completed' | 'failed' required
messagestring
externalIdstring

Response

Status updated

previousStatus'ready' | 'started' | 'completed' | 'abandoned' | 'failed'
currentStatus'ready' | 'started' | 'completed' | 'abandoned' | 'failed'

Changes

No recorded changes to this operation across all 1 revision of this API.