Skip to main content
GET
/
api
/
v2
/
jobs
/
available
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": 123,
      "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "client_name": "<string>",
      "event_id": {
        "int32": 123,
        "valid": true
      },
      "execution_time": "2023-11-07T05:31:56Z",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "status": -1,
      "status_message": "<string>",
      "session_collection": true,
      "local_group_collection": true,
      "ad_structure_collection": true,
      "cert_services_collection": true,
      "ca_registry_collection": true,
      "dc_registry_collection": true,
      "all_trusted_domains": true,
      "domain_controller": "<string>",
      "ous": [
        {
          "objectid": "<string>",
          "name": "<string>",
          "exists": true,
          "distinguishedname": "<string>",
          "type": "<string>"
        }
      ],
      "domains": [
        {
          "objectid": "<string>",
          "name": "<string>",
          "exists": true,
          "type": "<string>"
        }
      ],
      "domain_results": [
        {
          "id": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": {
            "time": "2023-11-07T05:31:56Z",
            "valid": true
          },
          "job_id": 123,
          "domain_name": "<string>",
          "success": true,
          "message": "<string>",
          "user_count": 123,
          "group_count": 123,
          "computer_count": 123,
          "gpo_count": 123,
          "ou_count": 123,
          "container_count": 123,
          "aiaca_count": 123,
          "rootca_count": 123,
          "enterpriseca_count": 123,
          "ntauthstore_count": 123,
          "certtemplate_count": 123,
          "deleted_count": 123
        }
      ]
    }
  ]
}
Applies to BloodHound Enterprise only

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

Query Parameters

​
sort_by
string

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. Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

​
log_path
string

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

​
session_collection
boolean

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

​
local_group_collection
boolean

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

​
cert_services_collection
boolean

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

​
ca_registry_collection
boolean

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

​
dc_registry_collection
boolean

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

​
ad_structure_collection
boolean

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

​
domain_controller
string

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

​
status
string

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

​
event_title
string

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

​
client_id
string<uuid>

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

​
event_id
integer

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

​
execution_time
string<date-time>

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

​
start_time
string<date-time>

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

​
end_time
string<date-time>

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

​
last_ingest
string<date-time>

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

​
hydrate_ous
boolean
default:true

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_domains
boolean
default:true

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_at
string<date-time>

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

​
updated_at
string<date-time>

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

​
deleted_at
string<date-time>

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

Response

OK

​
data
object[]