Clients
Enterprise

Creates a scheduled job

Changed on

Creates a new scheduled job

post/api/v2/clients/{client_id}/jobs

Request

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

Headers

Preferstring

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.

Request body

idinteger

This is the unique identifier for this object.

created_atstring date-time
updated_atstring date-time
client_idstring uuid
client_namestring
status-1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

This enum describes the current status of a Job. Values are:

  • -1 Invalid
  • 0 Ready
  • 1 Running
  • 2 Complete
  • 3 Canceled
  • 4 Timed Out
  • 5 Failed
  • 6 Ingesting
  • 7 Analyzing
  • 8 Partially Complete
statusMessagestring
start_timestring date-time
end_timestring date-time
session_collectionboolean
local_group_collectionboolean
ad_structure_collectionboolean
cert_services_collectionboolean
ca_registry_collectionboolean
dc_registry_collectionboolean
all_trusted_domainsboolean
event_titlestring
last_ingeststring date-time
ousstring[]
domainsstring[]

Response

OK

Changes

  • 51fa3598de15Revision changes
    • warning

      changed the pattern of the header request parameter Prefer from ^wait=[0-9]+$ to ^wait=(-1|[0-9]+)$

  • a426ff0abf8fRevision changes
    • warning

      changed the pattern of the header request parameter Prefer from ^wait=(-1|[0-9]+)$ to ^wait=[0-9]+$