Skip to main content
GET
List collector job history
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]+)$

Query Parameters

skip
integer

This query parameter is used for determining the number of objects to skip in pagination. The number of items to skip in a paginated response.

Required range: x >= 0
limit
integer

This query parameter is used for setting an upper limit of objects returned in paginated responses. The limit of results requested by the client.

Required range: x >= 0
sort_by
string

Sortable columns are recorded_at, job_created_at,last_claimed_at. Default is -recorded_at (most recent first). Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

job_schedule_id
string

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
job_profile_id
string

Filter results by column string-formatted uuid value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
job_type_id
string

Filter results by column integer value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?-?[0-9]+$
job_key
string

Filter results by column string value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[^:]+$
outcome
string

Filter results by column string value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[^:]+$
priority
string

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$
last_claimed_by
string

Filter results by column string value. Valid filter predicates are eq, neq.

Pattern: ^((eq|neq):)?[^:]+$
recorded_at
string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$
job_created_at
string

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$

Response

OK

data
object
required
count
integer

The total number of results.

Required range: x >= 0
skip
integer

The number of items to skip in a paginated response.

Required range: x >= 0
limit
integer

The limit of results requested by the client.

Required range: x >= 0