Notifies the API of a job ending

Endpoint for clients to end a job and mark the end time.

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.

Authorizations

Authorization

string

header

required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer

integer

default:

0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x > 0

Response

200

application/json

OK

data

object

Show child attributes

data.id

integer

This is the unique identifier for this object.

data.created_at

string

data.updated_at

string

data.deleted_at

object

Show child attributes

data.deleted_at.time

string

An RFC-3339 formatted string

data.deleted_at.valid

boolean

Valid is true if time is not null.

data.client_id

string

data.client_name

string

data.event_id

object

Show child attributes

data.event_id.int32

integer

data.event_id.valid

boolean

Valid is true if int32 is not null.

data.status

enum<integer>

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

Available options:

-1,

0,

1,

2,

3,

4,

5,

6,

7,

8

data.statusMessage

string

data.start_time

string

data.end_time

string

data.log_path

object

Show child attributes

data.log_path.string

string

data.log_path.valid

boolean

Valid is true if string`` is not null`

data.session_collection

boolean

data.local_group_collection

boolean

data.ad_structure_collection

boolean

data.cert_services_collection

boolean

data.ca_registry_collection

boolean

data.dc_registry_collection

boolean

data.all_trusted_domains

boolean

data.domain_controller

object

Show child attributes

data.domain_controller.string

string

data.domain_controller.valid

boolean

Valid is true if string`` is not null`

data.event_title

string

data.last_ingest

string

data.ous

string[]

data.domains

string[]

data.domain_results

object[]

Show child attributes

data.domain_results.id

integer

This is the unique identifier for this object.

data.domain_results.created_at

string

data.domain_results.updated_at

string

data.domain_results.deleted_at

object

Show child attributes

data.domain_results.deleted_at.time

string

An RFC-3339 formatted string

data.domain_results.deleted_at.valid

boolean

Valid is true if time is not null.

data.domain_results.job_id

integer

data.domain_results.domain_name

string

Name of the domain that was enumerated

data.domain_results.success

boolean

A boolean value indicating whether the domain enumeration succeeded

data.domain_results.message

string

A status message for a domain enumeration result

data.domain_results.user_count

integer

A count of users enumerated

data.domain_results.group_count

integer

A count of groups enumerated

data.domain_results.computer_count

integer

A count of computers enumerated

data.domain_results.gpo_count

integer

A count of gpos enumerated

data.domain_results.ou_count

integer

A count of ous enumerated

data.domain_results.container_count

integer

A count of containers enumerated

data.domain_results.aiaca_count

integer

A count of aiacas enumerated

data.domain_results.rootca_count

integer

A count of rootcas enumerated

data.domain_results.enterpriseca_count

integer

A count of enterprisecas enumerated

data.domain_results.ntauthstore_count

integer

A count of ntauthstores enumerated

data.domain_results.certtemplate_count

integer

A count of certtemplates enumerated

data.domain_results.deleted_count

integer

A count of deleted objects enumerated