/
SP
specterops
/
BloodHound API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 25m ago · Updated 2d ago
View markdown
specterops
BloodHound API
post
Create Client
OpenAPI 3.0.3
Apache-2.0
raw.githubusercontent.com
2026-08-12
281
150
772.9 KB
8a17345ab0c1
AD Base Entities
3
AD Users
11
AIA CAs
3
Analysis
3
API Info
2
API Tokens
3
Asset Isolation
33
Attack Paths
11
Audit
1
Auth
14
Azure Entities
1
BloodHound Users
12
Cert Templates
3
Client Ingest
1
Clients
22
get
List Clients
post
Create Client
post
Client Error
put
Update Client Values
get
Get Client
put
Update Client
delete
Delete Client
put
Regenerate the authentication token for a client
get
List all completed tasks for a client
get
List all completed jobs for a client
post
Creates a scheduled task
post
Creates a scheduled job
post
Queues a management operation
get
Download a management operation artifact for the client
delete
Delete a management operation artifact for the client
get
Get available management operations
post
Notifies the API of a management operation start
post
Notifies the API of a management operation ending
post
Create an artifact upload session
get
Get an artifact upload session
post
Upload an artifact part
post
Complete an artifact upload session
Collection Uploads
6
Collectors
6
Computers
16
Config
4
Containers
2
Custom Node Management
5
Cypher
12
Data Quality
6
Database
1
Datapipe
4
Domains
17
Enterprise CAs
4
EULA
1
Events (Schedules)
5
GPOs
6
Graph
7
Groups
10
Jobs
9
Meta Entities
1
NT Auth Stores
3
OpenGraph (Experimental)
8
OUs
5
Permissions
2
Risk Posture
2
Roles
2
Root CAs
3
Search
2
Tasks
9
Clients
Enterprise
Create Client
Creates a client for collection events
post
/api/v2/clients
Request body
object
required
name
string
domain_controller
string
type
'sharphound'
|
'azurehound'
|
'openhound'
This enum describes the collector client type.
events
ModelClientSchedule[]
Response
OK
object
required
data
ModelClient