Create Event

Creates a scheduled event for data collection

POST /api/v2/events

Create Event

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rrule": "<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,
  "ous": [
    "<string>"
  ],
  "domains": [
    "<string>"
  ]
}
'

import requests

url = "https://your-tenant.bloodhoundenterprise.io/api/v2/events"

payload = {
    "rrule": "<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,
    "ous": ["<string>"],
    "domains": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rrule: '<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,
    ous: ['<string>'],
    domains: ['<string>']
  })
};

fetch('https://your-tenant.bloodhoundenterprise.io/api/v2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-tenant.bloodhoundenterprise.io/api/v2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'rrule' => '<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,
    'ous' => [
        '<string>'
    ],
    'domains' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-tenant.bloodhoundenterprise.io/api/v2/events"

	payload := strings.NewReader("{\n  \"rrule\": \"<string>\",\n  \"session_collection\": true,\n  \"local_group_collection\": true,\n  \"ad_structure_collection\": true,\n  \"cert_services_collection\": true,\n  \"ca_registry_collection\": true,\n  \"dc_registry_collection\": true,\n  \"all_trusted_domains\": true,\n  \"ous\": [\n    \"<string>\"\n  ],\n  \"domains\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-tenant.bloodhoundenterprise.io/api/v2/events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rrule\": \"<string>\",\n  \"session_collection\": true,\n  \"local_group_collection\": true,\n  \"ad_structure_collection\": true,\n  \"cert_services_collection\": true,\n  \"ca_registry_collection\": true,\n  \"dc_registry_collection\": true,\n  \"all_trusted_domains\": true,\n  \"ous\": [\n    \"<string>\"\n  ],\n  \"domains\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-tenant.bloodhoundenterprise.io/api/v2/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rrule\": \"<string>\",\n  \"session_collection\": true,\n  \"local_group_collection\": true,\n  \"ad_structure_collection\": true,\n  \"cert_services_collection\": true,\n  \"ca_registry_collection\": true,\n  \"dc_registry_collection\": true,\n  \"all_trusted_domains\": true,\n  \"ous\": [\n    \"<string>\"\n  ],\n  \"domains\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": 123,
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rrule": "<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,
    "ous": [
      {
        "objectid": "<string>",
        "name": "<string>",
        "exists": true,
        "distinguishedname": "<string>",
        "type": "<string>"
      }
    ],
    "domains": [
      {
        "objectid": "<string>",
        "name": "<string>",
        "exists": true,
        "type": "<string>"
      }
    ]
  }
}

{
  "http_status": 400,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The JSON payload could not be unmarshalled."
    }
  ]
}

{
  "http_status": 401,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "login",
      "message": "Unauthorized"
    }
  ]
}

{
  "http_status": 403,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "You do not have permission to access this resource"
    }
  ]
}

{
  "http_status": 500,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The request could not be handled due to an unexpected database error."
    }
  ]
}

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

The request body for creating an event

rrule · string

session_collection · boolean

local_group_collection · boolean

ad_structure_collection · boolean

cert_services_collection · boolean

ca_registry_collection · boolean

dc_registry_collection · boolean

all_trusted_domains · boolean

ous · string[]

domains · string[]

Response

200

application/json

OK

data · object

Show child attributes