Skip to main content
POST
End a collector job
Applies to BloodHound Enterprise

Authorizations

Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer
string
default:wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

collector_job_id
string<uuid>
required

Collector job queue or history UUID.

Body

application/json
outcome
enum<string>
required
Available options:
succeeded,
partially-succeeded,
failed,
cancelled,
requeue
failure_message
string
metadata
object

Persisted as outcome_metadata for terminal outcomes.

Response

OK