Notifies the API of a job start

Endpoint for clients to start a new job and mark the start 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.

POST /api/v2/jobs/start

Notifies the API of a job start

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/jobs/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 123
}'

200

{
  "data": {
    "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
    },
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "client_name": "<string>",
    "event_id": {
      "int32": 123,
      "valid": true
    },
    "statusMessage": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "log_path": {
      "string": "<string>",
      "valid": true
    },
    "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": "<string>",
      "valid": true
    },
    "event_title": "<string>",
    "last_ingest": "2023-11-07T05:31:56Z",
    "ous": [
      "<string>"
    ],
    "domains": [
      "<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
      }
    ]
  }
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

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]+)$

Body

application/json

id · integer<int64>

Response

200

application/json

OK

data · object

Show child attributes