Jobs
Enterprise

List available client jobs

Changed on

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

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/jobs/available
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

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

Changes

  • f87a90d5a2d0Revision changes
    • breaking

      added the pattern ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ to the query request parameter client_id

    • info

      for the query request parameter client_id, the format was generalized from uuid to no format

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ad_structure_collection

    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter ca_registry_collection

    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter cert_services_collection

    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter dc_registry_collection

    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter local_group_collection

    • breaking

      added the pattern ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$ to the query request parameter session_collection

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter event_id

    • breaking

      added the 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})$ to the query request parameter created_at

    • breaking

      added the 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})$ to the query request parameter deleted_at

    • breaking

      added the 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})$ to the query request parameter end_time

    • breaking

      added the 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})$ to the query request parameter execution_time

    • breaking

      added the 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})$ to the query request parameter last_ingest

    • breaking

      added the 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})$ to the query request parameter start_time

    • breaking

      added the 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})$ to the query request parameter updated_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter domain_controller

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter event_title

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter log_path

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter status

    • info

      for the query request parameter ad_structure_collection, the type was generalized from boolean to string

    • info

      for the query request parameter ca_registry_collection, the type was generalized from boolean to string

    • info

      for the query request parameter cert_services_collection, the type was generalized from boolean to string

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

      for the query request parameter dc_registry_collection, the type was generalized from boolean to string

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

      for the query request parameter end_time, the format was generalized from date-time to no format

    • info

      for the query request parameter event_id, the type was generalized from integer to string

    • info

      for the query request parameter execution_time, the format was generalized from date-time to no format

    • info

      for the query request parameter last_ingest, the format was generalized from date-time to no format

    • info

      for the query request parameter local_group_collection, the type was generalized from boolean to string

    • info

      for the query request parameter session_collection, the type was generalized from boolean to string

    • info

      for the query request parameter start_time, the format was generalized from date-time to no format

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format