bloodhound — API
BloodHound APIvv2 Read the vendor's spec ↗
- 309 endpoints
- 22 deprecated
- 6 versions archived since Jul 18, 2026
- Last checked Oct 26, 2026
This is the API that drives BloodHound Enterprise and Community Edition.
Get started
$ curl "/api/version" \
-H "Authorization: Bearer $TOKEN"
Set $TOKEN first, then paste.
- Base URL
-
/ - Authenticate
-
Bearer token in the Authorization header
Authorization: Bearer $JWT_TOKEN
3 other schemes
- API key in the Authorization header
- API key in the RequestDate header
- API key in the Signature header
What it covers
- Asset Isolation 33 create, read, update, delete
- Clients 24 create, read, update, delete
- Alerts 17 create, read, update, delete
- Domains 17 read, update
- Computers 16 read
- Auth 14 create, read, update, delete
- Bloodhound Users 12 create, read, update, delete
- Cypher 12 create, read, update, delete
- Ad Users 11 read
- Attack Paths 11 read, update
- Groups 10 read
- Jobs 9 create, read, update
36 more areas
- Tasks 9 create, read, update
- Opengraph (experimental) 8 read, update, delete
- Gpos 7 read
- Graph 7 read
- Collection Uploads 6 create, read
- Collectors 6 read
- Data Quality 6 read
- Custom Node Management 5 create, read, update, delete
- Events (schedules) 5 create, read, update, delete
- Ous 5 read
- Sites 5 read
- Config 4 read, update
- Datapipe 4 read, update, delete
- Enterprise Cas 4 read
- Ad Base Entities 3 read
- Aia Cas 3 read
- Api Tokens 3 create, read, delete
- Analysis 3 read
- Cert Templates 3 read
- Nt Auth Stores 3 read
- Root Cas 3 read
- Api Info 2 read
- Containers 2 read
- Permissions 2 read
- Risk Posture 2 read
- Roles 2 read
- Search 2 read
- Asset Scores 1 read
- Audit 1 read
- Azure Entities 1 read
- Client Ingest 1 create
- Database 1 create
- Eula 1 update
- Meta Entities 1 read
- Site Servers 1 read
- Site Subnets 1 read
Open an endpoint for a runnable command, its inputs and what it returns.
endpoint surface across archived versions
endpoints at that version
added
removed
endpoint changes per archived version — drag across the rail to set a range
Asset Isolation 33
-
DELETE
/api/v2/asset-group-tags/{asset_group_tag_id}Delete an Asset Group TagLoading…
-
DELETE
/api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}Delete Asset Group Tag SelectorLoading…
-
DELETE
/api/v2/asset-groups/{asset_group_id}Delete an asset groupLoading…
-
DELETE
/api/v2/asset-groups/{asset_group_id}/selectors/{asset_group_selector_id}Delete an asset group selectorLoading…
-
GET
/api/v2/asset-group-tagsGet Asset Group TagsLoading…
-
GET
/api/v2/asset-group-tags-historyGet history recordsLoading…
-
GET
/api/v2/asset-group-tags/certificationsGet certifications for privilege zonesLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}Get Asset Group TagLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/membersList asset group tag members by IDLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/members/countsList asset group tag member count by kindLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/members/{asset_group_member_id}Get asset group tag selectors of a specific object by member idLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/selectorsGet Asset Group Tag selectorsLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}Get Asset Group Tag SelectorLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}/membersList asset group tag members by selectorLoading…
-
GET
/api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}/members/countsList asset group tag selector member count by kindLoading…
-
GET
/api/v2/asset-groupsList all asset isolation groupsLoading…
-
GET
/api/v2/asset-groups/{asset_group_id}Get asset group by IDLoading…
-
GET
/api/v2/asset-groups/{asset_group_id}/collectionsList asset group collectionsLoading…
-
GET
/api/v2/asset-groups/{asset_group_id}/custom-selectorsGet asset group custom member countLoading…
-
GET
/api/v2/asset-groups/{asset_group_id}/membersList all asset isolation group members deprecatedLoading…
-
GET
/api/v2/asset-groups/{asset_group_id}/members/countsList asset group member count by kindLoading…
-
PATCH
/api/v2/asset-group-tags/{asset_group_tag_id}Update Asset Group TagLoading…
-
PATCH
/api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}Update Asset Group Tag SelectorLoading…
-
POST
/api/v2/asset-group-tagsCreate Asset Group TagLoading…
-
POST
/api/v2/asset-group-tags-historySearch history recordsLoading…
-
POST
/api/v2/asset-group-tags/certificationsCertify or Revoke Certification of ObjectsLoading…
-
POST
/api/v2/asset-group-tags/preview-selectorsPreview SelectorsLoading…
-
POST
/api/v2/asset-group-tags/searchSearch Asset Group TagsLoading…
-
POST
/api/v2/asset-group-tags/{asset_group_tag_id}/selectorsCreate Asset Group Tag SelectorLoading…
-
POST
/api/v2/asset-groupsCreate an asset groupLoading…
-
POST
/api/v2/asset-groups/{asset_group_id}/selectorsUpdate asset group selectors deprecatedLoading…
-
PUT
/api/v2/asset-groups/{asset_group_id}Update an asset groupLoading…
-
PUT
/api/v2/asset-groups/{asset_group_id}/selectorsUpdate asset group selectorsLoading…
Clients 24
-
DELETE
/api/v2/clients/{client_id}Delete ClientLoading…
-
DELETE
/api/v2/clients/{client_id}/artifacts/{artifact_id}Delete a management operation artifact for the clientLoading…
-
GET
/api/v2/clientsList ClientsLoading…
-
GET
/api/v2/clients/management/artifacts/{artifact_id}Get an artifact upload sessionLoading…
-
GET
/api/v2/clients/management/availableGet available management operationsLoading…
-
GET
/api/v2/clients/{client_id}Get ClientLoading…
-
GET
/api/v2/clients/{client_id}/artifacts/{artifact_id}Download a management operation artifact for the clientLoading…
-
GET
/api/v2/clients/{client_id}/artifacts/{artifact_id}/downloadDownload a management operation artifact for the clientLoading…
-
GET
/api/v2/clients/{client_id}/completed-jobsList all completed jobs for a clientLoading…
-
GET
/api/v2/clients/{client_id}/completed-tasksList all completed tasks for a client deprecatedLoading…
-
POST
/api/v2/clientsCreate ClientLoading…
-
POST
/api/v2/clients/errorClient ErrorLoading…
-
POST
/api/v2/clients/management/artifactsCreate an artifact upload sessionLoading…
-
POST
/api/v2/clients/management/artifacts/{artifact_id}/completeComplete an artifact upload sessionLoading…
-
POST
/api/v2/clients/management/artifacts/{artifact_id}/parts/{part_number}Upload an artifact partLoading…
-
POST
/api/v2/clients/management/endNotifies the API of a management operation endingLoading…
-
POST
/api/v2/clients/management/startNotifies the API of a management operation startLoading…
-
POST
/api/v2/clients/{client_id}/artifacts/{artifact_id}/download-urlGet a client artifact download URLLoading…
-
POST
/api/v2/clients/{client_id}/jobsCreates a scheduled jobLoading…
-
POST
/api/v2/clients/{client_id}/managementQueues a management operationLoading…
-
POST
/api/v2/clients/{client_id}/tasksCreates a scheduled task deprecatedLoading…
-
PUT
/api/v2/clients/updateUpdate Client ValuesLoading…
-
PUT
/api/v2/clients/{client_id}Update ClientLoading…
-
PUT
/api/v2/clients/{client_id}/tokenRegenerate the authentication token for a clientLoading…
Alerts 17
-
DELETE
/api/v2/alert-webhooks/{alert_webhook_id}Delete Alert WebhookLoading…
-
DELETE
/api/v2/alerts/{alert_id}Delete AlertLoading…
-
GET
/api/v2/alert-attemptsList Alert AttemptsLoading…
-
GET
/api/v2/alert-event-typesList Alert Event TypesLoading…
-
GET
/api/v2/alert-eventsList Alert EventsLoading…
-
GET
/api/v2/alert-events/{alert_event_id}Get Alert EventLoading…
-
GET
/api/v2/alert-webhooksList Alert WebhooksLoading…
-
GET
/api/v2/alert-webhooks/{alert_webhook_id}Get Alert WebhookLoading…
-
GET
/api/v2/alertsList AlertsLoading…
-
GET
/api/v2/alerts/{alert_id}Get AlertLoading…
-
PATCH
/api/v2/alert-webhooks/{alert_webhook_id}Update Alert WebhookLoading…
-
PATCH
/api/v2/alerts/{alert_id}Update AlertLoading…
-
POST
/api/v2/alert-attempts/retryRetry Alert AttemptLoading…
-
POST
/api/v2/alert-webhooksCreate Alert WebhookLoading…
-
POST
/api/v2/alert-webhooks/{alert_webhook_id}/rotate-secretRotate Alert Webhook SecretLoading…
-
POST
/api/v2/alert-webhooks/{alert_webhook_id}/testTest Alert WebhookLoading…
-
POST
/api/v2/alertsCreate AlertLoading…
Domains 17
-
GET
/api/v2/domains/{object_id}Get domain entity infoLoading…
-
GET
/api/v2/domains/{object_id}/adcs-escalationsGet ADCS escalations of Domain entityLoading…
-
GET
/api/v2/domains/{object_id}/computersGet domain entity computersLoading…
-
GET
/api/v2/domains/{object_id}/controllersGet domain entity controllersLoading…
-
GET
/api/v2/domains/{object_id}/dc-syncersGet domain entity DC SyncersLoading…
-
GET
/api/v2/domains/{object_id}/foreign-adminsGet domain entity foreign adminsLoading…
-
GET
/api/v2/domains/{object_id}/foreign-gpo-controllersGet domain entity foreign GPO controllersLoading…
-
GET
/api/v2/domains/{object_id}/foreign-groupsGet domain entity foregin groupsLoading…
-
GET
/api/v2/domains/{object_id}/foreign-usersGet domain entity foreign usersLoading…
-
GET
/api/v2/domains/{object_id}/gposGet domain entity GPOsLoading…
-
GET
/api/v2/domains/{object_id}/groupsGet domain entity groupsLoading…
-
GET
/api/v2/domains/{object_id}/inbound-trustsGet domain entity inbound trustsLoading…
-
GET
/api/v2/domains/{object_id}/linked-gposGet domain entity linked GPOsLoading…
-
GET
/api/v2/domains/{object_id}/ousGet domain entity OUsLoading…
-
GET
/api/v2/domains/{object_id}/outbound-trustsGet domain entity outbound trustsLoading…
-
GET
/api/v2/domains/{object_id}/usersGet domain entity usersLoading…
-
PATCH
/api/v2/domains/{object_id}Update the Domain entityLoading…
Computers 16
-
GET
/api/v2/computers/{object_id}Get computer entity infoLoading…
-
GET
/api/v2/computers/{object_id}/admin-rightsGet computer entity admin rightsLoading…
-
GET
/api/v2/computers/{object_id}/admin-usersGet computer entity adminsLoading…
-
GET
/api/v2/computers/{object_id}/constrained-delegation-rightsGet computer entity constrained delegation rightsLoading…
-
GET
/api/v2/computers/{object_id}/constrained-usersGet computer entity constrained usersLoading…
-
GET
/api/v2/computers/{object_id}/controllablesGet computer entity controllablesLoading…
-
GET
/api/v2/computers/{object_id}/controllersGet computer entity controllersLoading…
-
GET
/api/v2/computers/{object_id}/dcom-rightsGet computer entity DCOM rightsLoading…
-
GET
/api/v2/computers/{object_id}/dcom-usersGet computer entity DCOM usersLoading…
-
GET
/api/v2/computers/{object_id}/group-membershipGet computer entity group membershipLoading…
-
GET
/api/v2/computers/{object_id}/ps-remote-rightsGet computer entity remote PowerShell rightsLoading…
-
GET
/api/v2/computers/{object_id}/ps-remote-usersGet computer entity remote PowerShell usersLoading…
-
GET
/api/v2/computers/{object_id}/rdp-rightsGet computer entity RDP rightsLoading…
-
GET
/api/v2/computers/{object_id}/rdp-usersGet computer entity RDP usersLoading…
-
GET
/api/v2/computers/{object_id}/sessionsGet computer entity sessionsLoading…
-
GET
/api/v2/computers/{object_id}/sql-adminsGet computer entity SQL adminsLoading…
Auth 14
-
DELETE
/api/v2/saml/providers/{saml_provider_id}Delete a SAML Provider deprecatedLoading…
-
DELETE
/api/v2/sso-providers/{sso_provider_id}Delete SSO ProviderLoading…
-
GET
/api/v2/samlList SAML Providers deprecatedLoading…
-
GET
/api/v2/saml/providers/{saml_provider_id}Get SAML Provider deprecatedLoading…
-
GET
/api/v2/saml/ssoGet all SAML sign on endpoints deprecatedLoading…
-
GET
/api/v2/selfGet selfLoading…
-
GET
/api/v2/sso-providersList SSO ProvidersLoading…
-
GET
/api/v2/sso-providers/{sso_provider_id}/signing-certificateGet SAML Provider Signing CertificateLoading…
-
PATCH
/api/v2/sso-providers/{sso_provider_id}Update SSO ProviderLoading…
-
POST
/api/v2/loginLogin to BloodHoundLoading…
-
POST
/api/v2/logoutLogout of BloodHoundLoading…
-
POST
/api/v2/saml/providersCreate a New SAML Provider from Metadata deprecatedLoading…
-
POST
/api/v2/sso-providers/oidcCreate OIDC ProviderLoading…
-
POST
/api/v2/sso-providers/samlCreate a New SAML Provider from MetadataLoading…
Bloodhound Users 12
-
DELETE
/api/v2/bloodhound-users/{user_id}Delete a UserLoading…
-
DELETE
/api/v2/bloodhound-users/{user_id}/mfaUnenroll user from multi-factor authenticationLoading…
-
DELETE
/api/v2/bloodhound-users/{user_id}/secretExpire User SecretLoading…
-
GET
/api/v2/bloodhound-usersList UsersLoading…
-
GET
/api/v2/bloodhound-users-minimalList Users MinimalLoading…
-
GET
/api/v2/bloodhound-users/{user_id}Get a userLoading…
-
GET
/api/v2/bloodhound-users/{user_id}/mfa-activationReturns MFA activation status for a userLoading…
-
PATCH
/api/v2/bloodhound-users/{user_id}Update a UserLoading…
-
POST
/api/v2/bloodhound-usersCreate a New UserLoading…
-
POST
/api/v2/bloodhound-users/{user_id}/mfaEnrolls user in multi-factor authenticationLoading…
-
POST
/api/v2/bloodhound-users/{user_id}/mfa-activationActivates MFA for an enrolled userLoading…
-
PUT
/api/v2/bloodhound-users/{user_id}/secretCreate or Set User SecretLoading…
Cypher 12
-
DELETE
/api/v2/saved-queries/{saved_query_id}Delete a saved queryLoading…
-
DELETE
/api/v2/saved-queries/{saved_query_id}/permissionsRevokes permission of a saved query from usersLoading…
-
GET
/api/v2/saved-queriesList saved queriesLoading…
-
GET
/api/v2/saved-queries/exportExport one or more saved queriesLoading…
-
GET
/api/v2/saved-queries/{saved_query_id}Return a saved queryLoading…
-
GET
/api/v2/saved-queries/{saved_query_id}/exportExport a saved queryLoading…
-
GET
/api/v2/saved-queries/{saved_query_id}/permissionsRetrieves saved query permissions for provided query idLoading…
-
POST
/api/v2/graphs/cypherRun a cypher queryLoading…
-
POST
/api/v2/saved-queriesCreate a saved queryLoading…
-
POST
/api/v2/saved-queries/importImport one or more cypher queries.Loading…
-
PUT
/api/v2/saved-queries/{saved_query_id}Update a saved queryLoading…
-
PUT
/api/v2/saved-queries/{saved_query_id}/permissionsShare a saved query or set it to publicLoading…
Ad Users 11
-
GET
/api/v2/users/{object_id}Get User entity infoLoading…
-
GET
/api/v2/users/{object_id}/admin-rightsGet User entity admin rightsLoading…
-
GET
/api/v2/users/{object_id}/constrained-delegation-rightsGet User entity constrained delegation rightsLoading…
-
GET
/api/v2/users/{object_id}/controllablesGet User entity controllablesLoading…
-
GET
/api/v2/users/{object_id}/controllersGet User entity controllersLoading…
-
GET
/api/v2/users/{object_id}/dcom-rightsGet User entity DCOM rightsLoading…
-
GET
/api/v2/users/{object_id}/membershipsGet User entity membershipLoading…
-
GET
/api/v2/users/{object_id}/ps-remote-rightsGet User entity PowerShell remote rightsLoading…
-
GET
/api/v2/users/{object_id}/rdp-rightsGet User entity RDP rightsLoading…
-
GET
/api/v2/users/{object_id}/sessionsGet User entity sessionsLoading…
-
GET
/api/v2/users/{object_id}/sql-admin-rightsGet User entity SQL admin rightsLoading…
Attack Paths 11
-
GET
/api/v2/attack-path-typesList all attack path typesLoading…
-
GET
/api/v2/attack-paths/detailsGet all attack path findingsLoading…
-
GET
/api/v2/attack-paths/finding-trendsList finding trendsLoading…
-
GET
/api/v2/attack-paths/finding-typesList attack path finding typesLoading…
-
GET
/api/v2/attack-paths/findingsList attack path findingsLoading…
-
GET
/api/v2/domains/{domain_id}/attack-path-findingsExport attack path findings deprecatedLoading…
-
GET
/api/v2/domains/{domain_id}/available-typesList available attack pathsLoading…
-
GET
/api/v2/domains/{domain_id}/detailsList domain attack paths detailsLoading…
-
GET
/api/v2/domains/{domain_id}/sparklineList attack path sparkline valuesLoading…
-
PUT
/api/v2/attack-pathsStart analysisLoading…
-
PUT
/api/v2/attack-paths/{attack_path_id}/acceptanceUpdate attack path riskLoading…
Groups 10
-
GET
/api/v2/groups/{object_id}Get Group entity infoLoading…
-
GET
/api/v2/groups/{object_id}/admin-rightsGet Group entity admin rightsLoading…
-
GET
/api/v2/groups/{object_id}/controllablesGet Group entity controllablesLoading…
-
GET
/api/v2/groups/{object_id}/controllersGet Group entity controllersLoading…
-
GET
/api/v2/groups/{object_id}/dcom-rightsGet Group entity DCOMRightsLoading…
-
GET
/api/v2/groups/{object_id}/membersGet Group entity membersLoading…
-
GET
/api/v2/groups/{object_id}/membershipsGet Group entity membershipsLoading…
-
GET
/api/v2/groups/{object_id}/ps-remote-rightsGet Group entity PowerShell remote rightsLoading…
-
GET
/api/v2/groups/{object_id}/rdp-rightsGet Group entity RDP rightsLoading…
-
GET
/api/v2/groups/{object_id}/sessionsGet Group entity sessionsLoading…
Jobs 9
-
GET
/api/v2/jobsGet jobsLoading…
-
GET
/api/v2/jobs/availableList available client jobsLoading…
-
GET
/api/v2/jobs/currentGet client current jobLoading…
-
GET
/api/v2/jobs/finishedList finished jobsLoading…
-
GET
/api/v2/jobs/{job_id}Get client jobLoading…
-
GET
/api/v2/jobs/{job_id}/logGet Job Log FileLoading…
-
POST
/api/v2/jobs/endNotifies the API of a job endingLoading…
-
POST
/api/v2/jobs/startNotifies the API of a job startLoading…
-
PUT
/api/v2/jobs/{job_id}/cancelCancels a scheduled jobLoading…
Tasks 9
-
GET
/api/v2/tasksGet tasks deprecatedLoading…
-
GET
/api/v2/tasks/availableList available client tasks deprecatedLoading…
-
GET
/api/v2/tasks/currentGet client current task deprecatedLoading…
-
GET
/api/v2/tasks/finishedList finished tasks deprecatedLoading…
-
GET
/api/v2/tasks/{task_id}Get client task deprecatedLoading…
-
GET
/api/v2/tasks/{task_id}/logGet Task Log File deprecatedLoading…
-
POST
/api/v2/tasks/endNotifies the API of a task ending deprecatedLoading…
-
POST
/api/v2/tasks/startNotifies the API of a task start deprecatedLoading…
-
PUT
/api/v2/tasks/{task_id}/cancelCancels a scheduled task deprecatedLoading…
Opengraph (experimental) 8
-
DELETE
/api/v2/extensions/{extension_id}Delete OpenGraph ExtensionLoading…
-
GET
/api/v2/extensionsList OpenGraph Extensions InformationLoading…
-
GET
/api/v2/extensions-edgesList Edge KindsLoading…
-
GET
/api/v2/node-kinds/{node_kind_id}Get Node KindLoading…
-
GET
/api/v2/nodes/{node_id}Get Node by Graph Node IDLoading…
-
GET
/api/v2/relationship-kinds/{relationship_kind_id}Get Relationship KindLoading…
-
GET
/api/v2/relationships/{relationship_id}Get Relationship by Graph Relationship IDLoading…
-
PUT
/api/v2/extensionsUpserts the OpenGraph ExtensionLoading…
Gpos 7
-
GET
/api/v2/gpos/{object_id}Get GPO entity infoLoading…
-
GET
/api/v2/gpos/{object_id}/computersGet GPO entity computerLoading…
-
GET
/api/v2/gpos/{object_id}/controllersGet GPO entity controllersLoading…
-
GET
/api/v2/gpos/{object_id}/ousGet GPO entity OUsLoading…
-
GET
/api/v2/gpos/{object_id}/sitesGet GPO entity sitesLoading…
-
GET
/api/v2/gpos/{object_id}/tier-zeroGet GPO entity tier-zeroLoading…
-
GET
/api/v2/gpos/{object_id}/usersGet GPO entity usersLoading…
Graph 7
-
GET
/api/v2/graph-searchGet search resultLoading…
-
GET
/api/v2/graphs/acl-inheritanceGet ACL inheritance pathLoading…
-
GET
/api/v2/graphs/edge-compositionGet path compositionLoading…
-
GET
/api/v2/graphs/kindsGet kindsLoading…
-
GET
/api/v2/graphs/relay-targetsGet relay targetsLoading…
-
GET
/api/v2/graphs/shortest-pathGet the shortest path graphLoading…
-
GET
/api/v2/pathfindingGet pathfinding result deprecatedLoading…
Collection Uploads 6
-
GET
/api/v2/file-uploadList File Upload JobsLoading…
-
GET
/api/v2/file-upload/accepted-typesList accepted file upload typesLoading…
-
GET
/api/v2/file-upload/{file_upload_job_id}/completed-tasksGet Completed TasksLoading…
-
POST
/api/v2/file-upload/startCreate File Upload JobLoading…
-
POST
/api/v2/file-upload/{file_upload_job_id}Upload File To JobLoading…
-
POST
/api/v2/file-upload/{file_upload_job_id}/endEnd File Upload JobLoading…
Collectors 6
-
GET
/api/v2/collectors/{collector_type}Get collector manifestLoading…
-
GET
/api/v2/collectors/{collector_type}/{release_tag}Get collector download by versionLoading…
-
GET
/api/v2/collectors/{collector_type}/{release_tag}/checksumGet collector checksum by versionLoading…
-
GET
/api/v2/kennel/download/{asset_name}Download assetLoading…
-
GET
/api/v2/kennel/enterprise-manifestGet kennel enterprise manifestLoading…
-
GET
/api/v2/kennel/manifestGet kennel manifestLoading…
Data Quality 6
-
GET
/api/v2/ad-domains/{domain_id}/data-quality-statsGet AD domain data quality statsLoading…
-
GET
/api/v2/azure-tenants/{tenant_id}/data-quality-statsGet Azure tenant data quality statsLoading…
-
GET
/api/v2/completenessGet database completeness statsLoading…
-
GET
/api/v2/data-quality-statsGet environment-specific data quality statsLoading…
-
GET
/api/v2/data-quality-stats-aggregationsGet data quality aggregations by environment kindLoading…
-
GET
/api/v2/platform/{platform_id}/data-quality-statsGet platform data quality aggregateLoading…
Custom Node Management 5
-
DELETE
/api/v2/custom-nodes/{kind_name}Delete custom node (Deprecated) deprecatedLoading…
-
GET
/api/v2/custom-nodesGet custom nodesLoading…
-
GET
/api/v2/custom-nodes/{kind_name}Get custom nodeLoading…
-
POST
/api/v2/custom-nodesCreate custom nodesLoading…
-
PUT
/api/v2/custom-nodes/{kind_name}Update custom nodeLoading…
Events (schedules) 5
-
DELETE
/api/v2/events/{event_id}Delete EventLoading…
-
GET
/api/v2/eventsList eventsLoading…
-
GET
/api/v2/events/{event_id}Get EventLoading…
-
POST
/api/v2/eventsCreate EventLoading…
-
PUT
/api/v2/events/{event_id}Update EventLoading…
Ous 5
-
GET
/api/v2/ous/{object_id}Get OU entity infoLoading…
-
GET
/api/v2/ous/{object_id}/computersGet OU entity computersLoading…
-
GET
/api/v2/ous/{object_id}/gposGet OU entity GPOsLoading…
-
GET
/api/v2/ous/{object_id}/groupsGet OU entity groupsLoading…
-
GET
/api/v2/ous/{object_id}/usersGet OU entity usersLoading…
Sites 5
-
GET
/api/v2/sites/{object_id}Get Site entity infoLoading…
-
GET
/api/v2/sites/{object_id}/controllersGet Site entity controllersLoading…
-
GET
/api/v2/sites/{object_id}/linked-gposGet Site entity linked GPOsLoading…
-
GET
/api/v2/sites/{object_id}/siteserversGet Site entity site serversLoading…
-
GET
/api/v2/sites/{object_id}/sitesubnetsGet Site entity site subnetsLoading…
Config 4
-
GET
/api/v2/configList application config parametersLoading…
-
GET
/api/v2/featuresList feature flagsLoading…
-
PUT
/api/v2/configWrite application configuration parametersLoading…
-
PUT
/api/v2/features/{feature_id}/toggleToggle a feature flag's enabled status to either enable or disable it.Loading…
Datapipe 4
-
DELETE
/api/v2/analysisCancels an analysis requestLoading…
-
GET
/api/v2/analysisGets analysis request informationLoading…
-
GET
/api/v2/datapipe/statusGet datapipe statusLoading…
-
PUT
/api/v2/analysisStart analysisLoading…
Enterprise Cas 4
-
GET
/api/v2/enterprisecas/{object_id}Get Enterprise CA entity infoLoading…
-
GET
/api/v2/enterprisecas/{object_id}/controllersGet Enterprise CA entity controllersLoading…
-
GET
/api/v2/enterprisecas/{object_id}/pki-hierarchyGet PKI hierarchy of Enterprise CA entityLoading…
-
GET
/api/v2/enterprisecas/{object_id}/published-templatesGet published certificate templates of Enterprise CA entityLoading…
Ad Base Entities 3
-
GET
/api/v2/base/{object_id}Get entity infoLoading…
-
GET
/api/v2/base/{object_id}/controllablesGet entity controllablesLoading…
-
GET
/api/v2/base/{object_id}/controllersGet entity controllersLoading…
Aia Cas 3
-
GET
/api/v2/aiacas/{object_id}Get AIA CA entity infoLoading…
-
GET
/api/v2/aiacas/{object_id}/controllersGet AIA CA entity controllersLoading…
-
GET
/api/v2/aiacas/{object_id}/pki-hierarchyGet PKI hierarchy of AIA CA entityLoading…
Analysis 3
-
GET
/api/v2/asset-groups/{asset_group_id}/combo-nodeGet the combo tree for an asset group deprecatedLoading…
-
GET
/api/v2/meta-nodes/{domain_id}Get latest tier zero combo nodeLoading…
-
GET
/api/v2/meta-trees/{domain_id}Get the graph for meta treeLoading…
Api Tokens 3
-
DELETE
/api/v2/tokens/{token_id}Delete a User TokenLoading…
-
GET
/api/v2/tokensList Auth TokensLoading…
-
POST
/api/v2/tokensCreate Token for UserLoading…
Cert Templates 3
-
GET
/api/v2/certtemplates/{object_id}Get Cert Template entity infoLoading…
-
GET
/api/v2/certtemplates/{object_id}/controllersGet Cert Template entity controllersLoading…
-
GET
/api/v2/certtemplates/{object_id}/published-to-casGet Enterprise CAs having Cert Template entity publishedLoading…
Nt Auth Stores 3
-
GET
/api/v2/ntauthstores/{object_id}Get NT Auth Store entity infoLoading…
-
GET
/api/v2/ntauthstores/{object_id}/controllersGet NT Auth Store entity controllersLoading…
-
GET
/api/v2/ntauthstores/{object_id}/trusted-casGet trusted Enterprise CAs of NT Auth Store entityLoading…
Root Cas 3
-
GET
/api/v2/rootcas/{object_id}Get Root CA entity infoLoading…
-
GET
/api/v2/rootcas/{object_id}/controllersGet Root CA entity controllersLoading…
-
GET
/api/v2/rootcas/{object_id}/pki-hierarchyGet PKI hierarchy of Root CA entityLoading…
Api Info 2
-
GET
/api/v2/specGet API SpecLoading…
-
GET
/api/versionGet API versionLoading…
Containers 2
-
GET
/api/v2/containers/{object_id}Get container entity infoLoading…
-
GET
/api/v2/containers/{object_id}/controllersGet container entity controllersLoading…
Permissions 2
-
GET
/api/v2/permissionsList PermissionsLoading…
-
GET
/api/v2/permissions/{permission_id}Get PermissionLoading…
Risk Posture 2
-
GET
/api/v2/posture-history/{data_type}Get Posture HistoryLoading…
-
GET
/api/v2/posture-statsGet Posture StatisticsLoading…
Roles 2
-
GET
/api/v2/rolesList RolesLoading…
-
GET
/api/v2/roles/{role_id}Get RoleLoading…
Search 2
-
GET
/api/v2/available-domainsGet available domainsLoading…
-
GET
/api/v2/searchSearch for objectsLoading…
Asset Scores 1
-
GET
/api/v2/asset-scores/zone-protected-asset-scoreGet zone protected asset scoreLoading…
Audit 1
-
GET
/api/v2/auditList audit logsLoading…
Azure Entities 1
-
GET
/api/v2/azure/{entity_type}Get Azure entityLoading…
Client Ingest 1
-
POST
/api/v2/ingestEndpoint for data ingestionLoading…
Database 1
-
POST
/api/v2/clear-databaseDelete your BloodHound dataLoading…
Eula 1
-
PUT
/api/v2/accept-eulaAccept EULALoading…
Meta Entities 1
-
GET
/api/v2/meta/{object_id}Get Meta entity infoLoading…
Site Servers 1
-
GET
/api/v2/siteservers/{object_id}Get Site Server entity infoLoading…
Site Subnets 1
-
GET
/api/v2/sitesubnets/{object_id}Get Site Subnet entity infoLoading…
No endpoint matches. Clear the filter to see all 309.
Change log
-
- +GET /api/v2/gpos/{object_id}/sites
- +GET /api/v2/sites/{object_id}
- +GET /api/v2/sites/{object_id}/controllers
- +GET /api/v2/sites/{object_id}/linked-gpos
- +GET /api/v2/sites/{object_id}/siteservers
- +GET /api/v2/sites/{object_id}/sitesubnets
- +GET /api/v2/siteservers/{object_id}
- +GET /api/v2/sitesubnets/{object_id}
-
- +DELETE /api/v2/alert-webhooks/{alert_webhook_id}
- +DELETE /api/v2/alerts/{alert_id}
- +DELETE /api/v2/clients/{client_id}/artifacts/{artifact_id}
- +GET /api/v2/alert-attempts
- +GET /api/v2/alert-event-types
- +GET /api/v2/alert-events
- +GET /api/v2/alert-events/{alert_event_id}
- +GET /api/v2/alert-webhooks
- +GET /api/v2/alert-webhooks/{alert_webhook_id}
- +GET /api/v2/alerts
- +GET /api/v2/alerts/{alert_id}
- +GET /api/v2/asset-scores/zone-protected-asset-score
- +GET /api/v2/clients/management/artifacts/{artifact_id}
- +GET /api/v2/clients/management/available
- +GET /api/v2/clients/{client_id}/artifacts/{artifact_id}
- +GET /api/v2/clients/{client_id}/artifacts/{artifact_id}/download
- +PATCH /api/v2/alert-webhooks/{alert_webhook_id}
- +PATCH /api/v2/alerts/{alert_id}
- +POST /api/v2/alert-attempts/retry
- +POST /api/v2/alert-webhooks
- +POST /api/v2/alert-webhooks/{alert_webhook_id}/rotate-secret
- +POST /api/v2/alert-webhooks/{alert_webhook_id}/test
- +POST /api/v2/alerts
- +POST /api/v2/clients/management/artifacts
- +POST /api/v2/clients/management/artifacts/{artifact_id}/complete
- +POST /api/v2/clients/management/artifacts/{artifact_id}/parts/{part_number}
- +POST /api/v2/clients/management/end
- +POST /api/v2/clients/management/start
- +POST /api/v2/clients/{client_id}/artifacts/{artifact_id}/download-url
- +POST /api/v2/clients/{client_id}/management
-
- +GET /api/v2/attack-paths/finding-types
- +GET /api/v2/node-kinds/{node_kind_id}
- +GET /api/v2/relationship-kinds/{relationship_kind_id}
- −POST /api/v2/clients/management/end
- −POST /api/v2/clients/management/start
-
- ⚠DELETE /api/v2/custom-nodes/{kind_name}
- ⚠DELETE /api/v2/saml/providers/{saml_provider_id}
- ⚠GET /api/v2/asset-groups/{asset_group_id}/combo-node
- ⚠GET /api/v2/asset-groups/{asset_group_id}/members
- ⚠GET /api/v2/clients/{client_id}/completed-tasks
- ⚠GET /api/v2/domains/{domain_id}/attack-path-findings
- ⚠GET /api/v2/pathfinding
- ⚠GET /api/v2/saml
- ⚠GET /api/v2/saml/providers/{saml_provider_id}
- ⚠GET /api/v2/saml/sso
- ⚠GET /api/v2/tasks
- ⚠GET /api/v2/tasks/available
- ⚠GET /api/v2/tasks/current
- ⚠GET /api/v2/tasks/finished
- ⚠GET /api/v2/tasks/{task_id}
- ⚠GET /api/v2/tasks/{task_id}/log
- ⚠POST /api/v2/asset-groups/{asset_group_id}/selectors
- ⚠POST /api/v2/clients/{client_id}/tasks
- ⚠POST /api/v2/saml/providers
- ⚠POST /api/v2/tasks/end
- ⚠POST /api/v2/tasks/start
- ⚠PUT /api/v2/tasks/{task_id}/cancel
-
- +GET /api/v2/attack-paths/findings
- +GET /api/v2/data-quality-stats
- +GET /api/v2/data-quality-stats-aggregations
- +POST /api/v2/clients/management/end
- +POST /api/v2/clients/management/start