Skip to main content
GET
/
api
/
v2
/
jobs
Get jobs
curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/jobs \
  --header 'Authorization: Bearer <token>'
{
  "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
string
default:wait=30

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.

Pattern: ^wait=(-1|[0-9]+)$

Query Parameters

​
sort_by
string

Sortable columns are client_name, event_id, execution_time, status, start_time, end_time, log_path, domain_controller, event_title, last_ingest, id, created_at, updated_at, 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.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
session_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
local_group_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
cert_services_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
ca_registry_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
dc_registry_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
ad_structure_collection
string

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$
​
domain_controller
string

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

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
status
string

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

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
event_title
string

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

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
client_id
string

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

Pattern: ^((eq|neq):)?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
​
event_id
string

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

Pattern: ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$
​
execution_time
string

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

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})$
​
start_time
string

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

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})$
​
end_time
string

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

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})$
​
last_ingest
string

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

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})$
​
created_at
string

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.

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})$
​
updated_at
string

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.

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})$
​
deleted_at
string

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.

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})$

Response

OK

​
data
object[]