Sign in

v51

OpenAPI 3.0.3Apache-2.0raw.githubusercontent.com2026-08-01276140748.5 KB
Jobs
Enterprise

List available client jobs

Endpoint for clients to get next available jobs.

Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.

get/api/v2/jobs/available

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are event_id, execution_time, status, start_time, end_time, log_path, domain_controller, event_title, last_ingest, id, created_at, updated_at, and deleted_at.

log_pathstring

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

session_collectionstring

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

local_group_collectionstring

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

cert_services_collectionstring

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

ca_registry_collectionstring

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

dc_registry_collectionstring

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

ad_structure_collectionstring

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

domain_controllerstring

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

statusstring

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

event_titlestring

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

client_idstring

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

event_idstring

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

execution_timestring

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

start_timestring

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

end_timestring

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

last_ingeststring

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

hydrate_ousboolean

When a value of true is passed, any OUs associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same OUs will only return as a list of objectids.

hydrate_domainsboolean

When a value of true is passed, any Domains associated with scheduled and finished jobs for each client will have expanded properties including name and type. When a value of false is passed, these same Domains will only return as a list of objectids.

created_atstring

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

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

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

Filter results by updated_at value. See filter schema details for valid predicates.

deleted_atstring

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

Filter results by deleted_at value. See filter schema details for valid predicates.

Response

OK