# SpecterOps: API Reference

## API Reference

### Get Started

- [Use the BloodHound API](https://bloodhound.specterops.io/reference/overview.md)

### Auth

- [Login to BloodHound](https://bloodhound.specterops.io/reference/auth/login-to-bloodhound.md): Login to BloodHound with user credentials or a one time password.
- [Logout of BloodHound](https://bloodhound.specterops.io/reference/auth/logout-of-bloodhound.md): Logout of BloodHound and delete the user session JWT.
- [Get self](https://bloodhound.specterops.io/reference/auth/get-self.md): Get the currently authenticated requester details. For Community, this will only ever be valid for users. In Enterprise, this could be either a BloodHound user or a client (collector).
- [List SAML Providers](https://bloodhound.specterops.io/reference/auth/list-saml-providers.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` instead.
- [Get all SAML sign on endpoints](https://bloodhound.specterops.io/reference/auth/get-all-saml-sign-on-endpoints.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` instead to list available SSO endpoints.
- [Create a New SAML Provider from Metadata](https://bloodhound.specterops.io/reference/auth/create-a-new-saml-provider-from-metadata.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `POST /api/v2/sso-providers/saml` instead.
- [Get SAML Provider](https://bloodhound.specterops.io/reference/auth/get-saml-provider.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/sso-providers` to list all SAML providers instead.
- [Delete a SAML Provider](https://bloodhound.specterops.io/reference/auth/delete-a-saml-provider.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `DELETE /api/v2/sso-providers/{sso_provider_id}` instead.
- [List SSO Providers](https://bloodhound.specterops.io/reference/auth/list-sso-providers.md): Lists all available SSO providers (SAML and OIDC)
- [Create OIDC Provider](https://bloodhound.specterops.io/reference/auth/create-oidc-provider.md): Creates a new OIDC provider for SSO authentication
- [Create a New SAML Provider from Metadata](https://bloodhound.specterops.io/reference/auth/create-a-new-saml-provider-from-metadata-1.md): Creates a new SAML provider with the given name and metadata XML.
- [Delete SSO Provider](https://bloodhound.specterops.io/reference/auth/delete-sso-provider.md): Deletes an existing SSO provider
- [Update SSO Provider](https://bloodhound.specterops.io/reference/auth/update-sso-provider.md): Updates an existing SSO provider. Updating saml provider requires a "multipart/form-data" body. Updating oidc provider requires "application/json" body. Response is respective provider
- [Get SAML Provider Signing Certificate](https://bloodhound.specterops.io/reference/auth/get-saml-provider-signing-certificate.md): Download the SAML Provider Signing Certificate. Only applies to SAML providers.

### Permissions

- [List Permissions](https://bloodhound.specterops.io/reference/permissions/list-permissions.md): List all authorization permissions.
- [Get Permission](https://bloodhound.specterops.io/reference/permissions/get-permission.md): Gets an authorization permission's details.

### Roles

- [List Roles](https://bloodhound.specterops.io/reference/roles/list-roles.md): List all authorization roles.
- [Get Role](https://bloodhound.specterops.io/reference/roles/get-role.md): Gets an authorization role's details.

### API Tokens

- [List Auth Tokens](https://bloodhound.specterops.io/reference/api-tokens/list-auth-tokens.md): Get all auth tokens.
- [Create Token for User](https://bloodhound.specterops.io/reference/api-tokens/create-token-for-user.md): Create a new token to use with request signing based authentication for a given user.
- [Delete a User Token](https://bloodhound.specterops.io/reference/api-tokens/delete-a-user-token.md): Delete a request signing token for a given user.

### BloodHound Users

- [List Users](https://bloodhound.specterops.io/reference/bloodhound-users/list-users.md): Gets all BloodHound user details.
- [Create a New User](https://bloodhound.specterops.io/reference/bloodhound-users/create-a-new-user.md): Create a new BloodHound user.
- [List Users Minimal](https://bloodhound.specterops.io/reference/bloodhound-users/list-users-minimal.md): Returns all BloodHound user details without any sensitive data.
- [Get a user](https://bloodhound.specterops.io/reference/bloodhound-users/get-a-user.md): Get a BloodHound user's details.
- [Delete a User](https://bloodhound.specterops.io/reference/bloodhound-users/delete-a-user.md): Deletes an existing BloodHound user.
- [Update a User](https://bloodhound.specterops.io/reference/bloodhound-users/update-a-user.md): Update a BloodHound user's properties'.
- [Create or Set User Secret](https://bloodhound.specterops.io/reference/bloodhound-users/create-or-set-user-secret.md): Create or set a user's secret to use as a login password.
- [Expire User Secret](https://bloodhound.specterops.io/reference/bloodhound-users/expire-user-secret.md): Expire a user's secret to use as a login password.
- [Enrolls user in multi-factor authentication](https://bloodhound.specterops.io/reference/bloodhound-users/enrolls-user-in-multi-factor-authentication.md): Enrolls user in multi-factor authentication
- [Unenroll user from multi-factor authentication](https://bloodhound.specterops.io/reference/bloodhound-users/unenroll-user-from-multi-factor-authentication.md): Unenrolls user from multi-factor authentication
- [Returns MFA activation status for a user](https://bloodhound.specterops.io/reference/bloodhound-users/returns-mfa-activation-status-for-a-user.md): Returns multi-factor authentication status for a user
- [Activates MFA for an enrolled user](https://bloodhound.specterops.io/reference/bloodhound-users/activates-mfa-for-an-enrolled-user.md): Activates multi-factor authentication for an enrolled user

### Collectors

- [Get collector manifest](https://bloodhound.specterops.io/reference/collectors/get-collector-manifest.md): Retrieves the version manifest for a given collector
- [Get collector download by version](https://bloodhound.specterops.io/reference/collectors/get-collector-download-by-version.md): Retrieves the download for a given collector with given version
- [Get collector checksum by version](https://bloodhound.specterops.io/reference/collectors/get-collector-checksum-by-version.md): Retrieves the checksum file for a given collector with given version
- [Get kennel manifest](https://bloodhound.specterops.io/reference/collectors/get-kennel-manifest.md): Retrieves a manifest of community collectors
- [Get kennel enterprise manifest](https://bloodhound.specterops.io/reference/collectors/get-kennel-enterprise-manifest.md): Retrieves a manifest of enterprise collectors
- [Download asset](https://bloodhound.specterops.io/reference/collectors/download-asset.md): Downloads an enterprise asset (collector or checksum)

### Collection Uploads

- [List File Upload Jobs](https://bloodhound.specterops.io/reference/collection-uploads/list-file-upload-jobs.md): Lists available file upload jobs
- [Create File Upload Job](https://bloodhound.specterops.io/reference/collection-uploads/create-file-upload-job.md): Creates a file upload job for sending collection files
- [Upload File To Job](https://bloodhound.specterops.io/reference/collection-uploads/upload-file-to-job.md): Saves a collection file to a file upload job
- [Get Completed Tasks](https://bloodhound.specterops.io/reference/collection-uploads/get-completed-tasks.md): Get information about the individual completed file upload tasks associated with a job
- [End File Upload Job](https://bloodhound.specterops.io/reference/collection-uploads/end-file-upload-job.md): End a file upload job
- [List accepted file upload types](https://bloodhound.specterops.io/reference/collection-uploads/list-accepted-file-upload-types.md): List accepted file types for collection file uploads

### Custom Node Management

- [Get custom nodes](https://bloodhound.specterops.io/reference/custom-node-management/get-custom-nodes.md): Retrieve a list of all custom node configurations. This endpoint returns the current set of registered node kinds and their display settings.
- [Create custom nodes](https://bloodhound.specterops.io/reference/custom-node-management/create-custom-nodes.md): This endpoint registers new node kinds along with optional display metadata such as icons and colors. The provided configuration controls how nodes of the specified kinds are interpreted and rendered in the UI. Only free, solid-style Font Awesome icons are supported. Hex color codes must follow the…
- [Get custom node](https://bloodhound.specterops.io/reference/custom-node-management/get-custom-node.md): Retrieve the configuration for a specific custom node kind. Returns the display settings and metadata for the requested node kind.
- [Update custom node](https://bloodhound.specterops.io/reference/custom-node-management/update-custom-node.md): This endpoint updates an existing node kind along with optional display metadata such as icons and colors. The provided configuration controls how nodes of the specified kinds are interpreted and rendered in the UI. Only free, solid-style Font Awesome icons are supported. Hex color codes must follow…
- [Delete custom node (Deprecated)](https://bloodhound.specterops.io/reference/custom-node-management/delete-custom-node-deprecated.md): **Deprecated**: This endpoint is no longer supported and will return 410 Gone.

### API Info

- [Get API version](https://bloodhound.specterops.io/reference/api-info/get-api-version.md): Returns the supported API versions.
- [Get API Spec](https://bloodhound.specterops.io/reference/api-info/get-api-spec.md): Returns an Open API 3.0 compatible BloodHound API spec

### Search

- [Search for objects](https://bloodhound.specterops.io/reference/search/search-for-objects.md): Search for graph objects by name or object ID, filtered by type.
- [Get available domains](https://bloodhound.specterops.io/reference/search/get-available-domains.md): Gets available domains along with their collection status

### Audit

- [List audit logs](https://bloodhound.specterops.io/reference/audit/list-audit-logs.md): Returns a list of audit logs.

### Config

- [List application config parameters](https://bloodhound.specterops.io/reference/config/list-application-config-parameters.md): Lists application configuration parameters for this instance
- [Write application configuration parameters](https://bloodhound.specterops.io/reference/config/write-application-configuration-parameters.md): Writes application configuration parameters for this instance
- [List feature flags](https://bloodhound.specterops.io/reference/config/list-feature-flags.md): Lists all feature flags for this instance
- [Toggle a feature flag's enabled status to either enable or disable it.](https://bloodhound.specterops.io/reference/config/toggle-a-feature-flags-enabled-status-to-either-enable-or-disable-it.md): Writes application configuration parameters for this instance

### Asset Isolation

- [List all asset isolation groups](https://bloodhound.specterops.io/reference/asset-isolation/list-all-asset-isolation-groups.md): Lists all asset isolation groups.
- [Create an asset group](https://bloodhound.specterops.io/reference/asset-isolation/create-an-asset-group.md): Creates an asset group
- [Get asset group by ID](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-by-id.md): Retrieve asset group by ID
- [Update an asset group](https://bloodhound.specterops.io/reference/asset-isolation/update-an-asset-group.md): Updates an asset group
- [Delete an asset group](https://bloodhound.specterops.io/reference/asset-isolation/delete-an-asset-group.md): Deletes an asset group
- [List asset group collections](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-collections.md): Returns all historical memberships if no URL params are specified.
- [Update asset group selectors](https://bloodhound.specterops.io/reference/asset-isolation/update-asset-group-selectors.md): Updates asset group selectors
- [Update asset group selectors](https://bloodhound.specterops.io/reference/asset-isolation/update-asset-group-selectors-1.md): DEPRECATED use PUT instead. Updates asset group selectors.
- [Delete an asset group selector](https://bloodhound.specterops.io/reference/asset-isolation/delete-an-asset-group-selector.md): Deletes an asset group selector
- [Get asset group custom member count](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-custom-member-count.md): Get asset group custom member count
- [List all asset isolation group members](https://bloodhound.specterops.io/reference/asset-isolation/list-all-asset-isolation-group-members.md): **Deprecated**: This endpoint will no longer be supported in a future release. Please use `GET /api/v2/asset-group-tags/{asset_group_tag_id}/members` or `GET /api/v2/asset-group-tags/{asset_group_tag_id}/selectors/{asset_group_tag_selector_id}/members` instead.
- [List asset group member count by kind](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-member-count-by-kind.md): List counts of members of an asset isolation group by primary kind.
- [Get asset group tag selectors of a specific object by member id](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-tag-selectors-of-a-specific-object-by-member-id.md): Get a list of selectors for an object by member id.
- [Get Asset Group Tags](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-tags.md): Get a list of asset groups
- [Create Asset Group Tag](https://bloodhound.specterops.io/reference/asset-isolation/create-asset-group-tag.md): Creates an asset group tag ie. a tier or label
- [Get Asset Group Tag](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-tag.md): Retrieves an asset group tag by ID
- [Delete an Asset Group Tag](https://bloodhound.specterops.io/reference/asset-isolation/delete-an-asset-group-tag.md): Deletes an asset group tag
- [Update Asset Group Tag](https://bloodhound.specterops.io/reference/asset-isolation/update-asset-group-tag.md): Updates an asset group tag by ID
- [List asset group tag members by ID](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-tag-members-by-id.md): List members of an asset group tag by ID
- [List asset group tag member count by kind](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-tag-member-count-by-kind.md): List counts of members of an asset group tag by primary kind.
- [List asset group tag members by selector](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-tag-members-by-selector.md): List members of an asset group tag by selector
- [List asset group tag selector member count by kind](https://bloodhound.specterops.io/reference/asset-isolation/list-asset-group-tag-selector-member-count-by-kind.md): List counts of members of an asset group tag selector by primary kind.
- [Get Asset Group Tag selectors](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-tag-selectors.md): Get a list of selectors for this group.
- [Create Asset Group Tag Selector](https://bloodhound.specterops.io/reference/asset-isolation/create-asset-group-tag-selector.md): Creates an asset group tag selector.
- [Get Asset Group Tag Selector](https://bloodhound.specterops.io/reference/asset-isolation/get-asset-group-tag-selector.md): Retrieves an asset group tag selector by ID
- [Delete Asset Group Tag Selector](https://bloodhound.specterops.io/reference/asset-isolation/delete-asset-group-tag-selector.md): Delete an asset group tag selector
- [Update Asset Group Tag Selector](https://bloodhound.specterops.io/reference/asset-isolation/update-asset-group-tag-selector.md): Update an asset group tag selector's properties
- [Preview Selectors](https://bloodhound.specterops.io/reference/asset-isolation/preview-selectors.md): Sample preview of members selected by provided selector seeds.
- [Search Asset Group Tags](https://bloodhound.specterops.io/reference/asset-isolation/search-asset-group-tags.md): Supports searching by name on asset group tags and selectors, and by name or object ID on members.
- [Get history records](https://bloodhound.specterops.io/reference/asset-isolation/get-history-records.md): Retrieves history records for actions on asset group tags
- [Search history records](https://bloodhound.specterops.io/reference/asset-isolation/search-history-records.md): Retrieves history records via search string input and filtering by action, asset_group_tag_id, email, and actor
- [Get certifications for privilege zones](https://bloodhound.specterops.io/reference/asset-isolation/get-certifications-for-privilege-zones.md): Retrieves certification status for nodes selected by a zone
- [Certify or Revoke Certification of Objects](https://bloodhound.specterops.io/reference/asset-isolation/certify-or-revoke-certification-of-objects.md): Manually certify/revoke certification of objects as belonging to the Zone they're selected by

### Graph

- [Get kinds](https://bloodhound.specterops.io/reference/graph/get-kinds.md): Gets kinds
- [Get pathfinding result](https://bloodhound.specterops.io/reference/graph/get-pathfinding-result.md): DEPRECATED use GetShortestPath instead. Get the result of pathfinding between two nodes in graph format.
- [Get search result](https://bloodhound.specterops.io/reference/graph/get-search-result.md): Get the result of searching a graph for a node by name
- [Get the shortest path graph](https://bloodhound.specterops.io/reference/graph/get-the-shortest-path-graph.md): A graph of the shortest path from `start_node` to `end_node`.
- [Get path composition](https://bloodhound.specterops.io/reference/graph/get-path-composition.md): Returns a graph representing the various nodes and edges that make up the complex post-processed edge.
- [Get relay targets](https://bloodhound.specterops.io/reference/graph/get-relay-targets.md): Returns a graph representing the various nodes that are valid relay targets for this edge
- [Get ACL inheritance path](https://bloodhound.specterops.io/reference/graph/get-acl-inheritance-path.md): Returns a graph representing the path that an ACE is inherited through for a given edge.

### OpenGraph (Experimental)

- [Get Relationship by Graph Relationship ID](https://bloodhound.specterops.io/reference/opengraph-experimental/get-relationship-by-graph-relationship-id.md): **Experimental** - Returns the details of a graph relationship identified by its graph-assigned integer ID
- [Get Node by Graph Node ID](https://bloodhound.specterops.io/reference/opengraph-experimental/get-node-by-graph-node-id.md): **Experimental** - Returns the details of a graph node identified by its graph-assigned integer ID
- [List OpenGraph Extensions Information](https://bloodhound.specterops.io/reference/opengraph-experimental/list-opengraph-extensions-information.md): **Experimental** - Lists pertinent OpenGraph extension information such as id, name, version, and if it is a built-in extension
- [Upserts the OpenGraph Extension](https://bloodhound.specterops.io/reference/opengraph-experimental/upserts-the-opengraph-extension.md): **Experimental** - Upserts the OpenGraph extension
- [Delete OpenGraph Extension](https://bloodhound.specterops.io/reference/opengraph-experimental/delete-opengraph-extension.md): **Experimental** - Deletes an OpenGraph Extension by Extension ID
- [List Edge Kinds](https://bloodhound.specterops.io/reference/opengraph-experimental/list-edge-kinds.md): **Experimental** - List all Edge Kinds across OpenGraph Schemas
- [Get Node Kind](https://bloodhound.specterops.io/reference/opengraph-experimental/get-node-kind.md): **Experimental** - Retrieves the details of a single OpenGraph node kind by its id, including its entity-panel info map keyed by info key.
- [Get Relationship Kind](https://bloodhound.specterops.io/reference/opengraph-experimental/get-relationship-kind.md): **Experimental** - Retrieves the details of a single OpenGraph relationship kind by its id, including its extension metadata and entity-panel info map keyed by info key.

### Cypher

- [List saved queries](https://bloodhound.specterops.io/reference/cypher/list-saved-queries.md): Get all saved queries for the current user
- [Create a saved query](https://bloodhound.specterops.io/reference/cypher/create-a-saved-query.md): Create a new saved query
- [Return a saved query](https://bloodhound.specterops.io/reference/cypher/return-a-saved-query.md): Returns an existing saved query by ID
- [Update a saved query](https://bloodhound.specterops.io/reference/cypher/update-a-saved-query.md): Update an existing saved query by ID
- [Delete a saved query](https://bloodhound.specterops.io/reference/cypher/delete-a-saved-query.md): Delete an existing saved query by ID
- [Retrieves saved query permissions for provided query id](https://bloodhound.specterops.io/reference/cypher/retrieves-saved-query-permissions-for-provided-query-id.md): Retrieves saved query permissions for provided query id
- [Share a saved query or set it to public](https://bloodhound.specterops.io/reference/cypher/share-a-saved-query-or-set-it-to-public.md): Shares an existing saved query or makes it public
- [Revokes permission of a saved query from users](https://bloodhound.specterops.io/reference/cypher/revokes-permission-of-a-saved-query-from-users.md): Revokes permission of a saved query from a given set of users
- [Export a saved query](https://bloodhound.specterops.io/reference/cypher/export-a-saved-query.md): Export an existing saved query by ID
- [Import one or more cypher queries.](https://bloodhound.specterops.io/reference/cypher/import-one-or-more-cypher-queries.md): Import one or more cypher queries.
- [Export one or more saved queries](https://bloodhound.specterops.io/reference/cypher/export-one-or-more-saved-queries.md): Export existing saved queries using the scope parameter.
- [Run a cypher query](https://bloodhound.specterops.io/reference/cypher/run-a-cypher-query.md): Runs a manual cypher query directly against the database.

### Azure Entities

- [Get Azure entity](https://bloodhound.specterops.io/reference/azure-entities/get-azure-entity.md): Retrieves entity information for the given Azure object ID. If `related_entity_type` parameter is not set, this endpoint will return information about a single entity. Using the `counts` boolean parameter will further modify the response. If `related_entity_type` parameter is set, this endpoint will…

### AD Base Entities

- [Get entity info](https://bloodhound.specterops.io/reference/ad-base-entities/get-entity-info.md): Get basic info and counts for this node.
- [Get entity controllables](https://bloodhound.specterops.io/reference/ad-base-entities/get-entity-controllables.md): Get a list, graph, or count of the principals this node can control.
- [Get entity controllers](https://bloodhound.specterops.io/reference/ad-base-entities/get-entity-controllers.md): Get a list, graph, or count of the principals that can control this node.

### Computers

- [Get computer entity info](https://bloodhound.specterops.io/reference/computers/get-computer-entity-info.md): Get info and counts for this computer node.
- [Get computer entity admin rights](https://bloodhound.specterops.io/reference/computers/get-computer-entity-admin-rights.md): Get a list, graph, or count of the systems this computer has admin rights to.
- [Get computer entity admins](https://bloodhound.specterops.io/reference/computers/get-computer-entity-admins.md): Get a list, graph, or count of the principals that have admin rights on this computer.
- [Get computer entity constrained delegation rights](https://bloodhound.specterops.io/reference/computers/get-computer-entity-constrained-delegation-rights.md): Get a list, graph, or count of the principals that this computer has constrained delegations rights to.
- [Get computer entity constrained users](https://bloodhound.specterops.io/reference/computers/get-computer-entity-constrained-users.md): Get a list, graph, or count of the principals that have constrained delegation rights to this computer.
- [Get computer entity controllables](https://bloodhound.specterops.io/reference/computers/get-computer-entity-controllables.md): Get a list, graph, or count of the principals this computer can control.
- [Get computer entity controllers](https://bloodhound.specterops.io/reference/computers/get-computer-entity-controllers.md): Get a list, graph, or count of the principals that can control this computer.
- [Get computer entity DCOM rights](https://bloodhound.specterops.io/reference/computers/get-computer-entity-dcom-rights.md): Get a list, graph, or count of the systems this computer can execute DCOM on.
- [Get computer entity DCOM users](https://bloodhound.specterops.io/reference/computers/get-computer-entity-dcom-users.md): Get a list, graph, or count of the principals that can execute DCOM on this computer.
- [Get computer entity group membership](https://bloodhound.specterops.io/reference/computers/get-computer-entity-group-membership.md): Get a list, graph, or count of the groups this computer is a member of.
- [Get computer entity remote PowerShell rights](https://bloodhound.specterops.io/reference/computers/get-computer-entity-remote-powershell-rights.md): Get a list, graph, or count of the systems this computer has remote PowerShell rights on.
- [Get computer entity remote PowerShell users](https://bloodhound.specterops.io/reference/computers/get-computer-entity-remote-powershell-users.md): Get a list, graph, or count of the principals that have remote PowerShell rights on this computer.
- [Get computer entity RDP rights](https://bloodhound.specterops.io/reference/computers/get-computer-entity-rdp-rights.md): Get a list, graph, or count of the systems this computer can RDP to.
- [Get computer entity RDP users](https://bloodhound.specterops.io/reference/computers/get-computer-entity-rdp-users.md): Get a list, graph, or count of the principals that have RDP rights on this computer.
- [Get computer entity sessions](https://bloodhound.specterops.io/reference/computers/get-computer-entity-sessions.md): Get a list, graph, or count of the principals with active sessions on this computer.
- [Get computer entity SQL admins](https://bloodhound.specterops.io/reference/computers/get-computer-entity-sql-admins.md): Get a list, graph, or count of the principals that have SQL admin rights on this computer.

### Containers

- [Get container entity info](https://bloodhound.specterops.io/reference/containers/get-container-entity-info.md): Get basic info and counts for this container node.
- [Get container entity controllers](https://bloodhound.specterops.io/reference/containers/get-container-entity-controllers.md): Get a list, graph, or count of the principals that can control this container.

### Domains

- [Get domain entity info](https://bloodhound.specterops.io/reference/domains/get-domain-entity-info.md): Get basic info and counts for this domain node.
- [Update the Domain entity](https://bloodhound.specterops.io/reference/domains/update-the-domain-entity.md): Updates the supported properties on the Domain entity.
- [Get domain entity computers](https://bloodhound.specterops.io/reference/domains/get-domain-entity-computers.md): Get a list or count of the computers that belong to this domain.
- [Get domain entity controllers](https://bloodhound.specterops.io/reference/domains/get-domain-entity-controllers.md): Get a list, graph, or count of the principals that can control this domain.
- [Get domain entity DC Syncers](https://bloodhound.specterops.io/reference/domains/get-domain-entity-dc-syncers.md): Get a list, graph, or count of the principals that can DC sync this domain.
- [Get domain entity foreign admins](https://bloodhound.specterops.io/reference/domains/get-domain-entity-foreign-admins.md): Get a list, graph, or count of the principals outside of this domain that have admin rights on principals in this domain.
- [Get domain entity foreign GPO controllers](https://bloodhound.specterops.io/reference/domains/get-domain-entity-foreign-gpo-controllers.md): Get a list, graph, or count of the principals outside of this domain that can control GPOs inside this domain.
- [Get domain entity foregin groups](https://bloodhound.specterops.io/reference/domains/get-domain-entity-foregin-groups.md): Get a list, graph, or count of the groups outside of this domain that are members of groups inside this domain.
- [Get domain entity foreign users](https://bloodhound.specterops.io/reference/domains/get-domain-entity-foreign-users.md): Get a list, graph, or count of the users outside of this domain that are members of groups inside this domain.
- [Get domain entity GPOs](https://bloodhound.specterops.io/reference/domains/get-domain-entity-gpos.md): Get a list or count of the GPOs in this domain.
- [Get domain entity groups](https://bloodhound.specterops.io/reference/domains/get-domain-entity-groups.md): Get a list or count of the groups in this domain.
- [Get domain entity inbound trusts](https://bloodhound.specterops.io/reference/domains/get-domain-entity-inbound-trusts.md): Get a list, graph, or count of the inbound trusts for this domain.
- [Get domain entity linked GPOs](https://bloodhound.specterops.io/reference/domains/get-domain-entity-linked-gpos.md): Get a list, graph, or count of the GPOs linked to this domain.
- [Get domain entity OUs](https://bloodhound.specterops.io/reference/domains/get-domain-entity-ous.md): Get a list or count of the OUs in this domain.
- [Get domain entity outbound trusts](https://bloodhound.specterops.io/reference/domains/get-domain-entity-outbound-trusts.md): Get a list, graph, or count of the outbound trusts for this domain.
- [Get domain entity users](https://bloodhound.specterops.io/reference/domains/get-domain-entity-users.md): Get a list or count of the users in this domain.
- [Get ADCS escalations of Domain entity](https://bloodhound.specterops.io/reference/domains/get-adcs-escalations-of-domain-entity.md): Get a list, graph, or count of the ADCS escalations of this Domain.

### GPOs

- [Get GPO entity info](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-info.md): Get info and counts for this GPO node.
- [Get GPO entity computer](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-computer.md): Get a list, graph, or count of the computers affected by this GPO.
- [Get GPO entity controllers](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-controllers.md): Get a list, graph, or count of the principals that can control this OU.
- [Get GPO entity OUs](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-ous.md): Get a list, graph, or count of the OUs affected by this GPO.
- [Get GPO entity tier-zero](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-tier-zero.md): Get a list, graph, or count of the tier-zero principals associated with this GPO.
- [Get GPO entity users](https://bloodhound.specterops.io/reference/gpos/get-gpo-entity-users.md): Get a list, graph, or count of the users affected by this GPO.

### AIA CAs

- [Get AIA CA entity info](https://bloodhound.specterops.io/reference/aia-cas/get-aia-ca-entity-info.md): Get info and counts for this AIA CA node.
- [Get AIA CA entity controllers](https://bloodhound.specterops.io/reference/aia-cas/get-aia-ca-entity-controllers.md): Get a list, graph, or count of the principals that can control this AIA CA.
- [Get PKI hierarchy of AIA CA entity](https://bloodhound.specterops.io/reference/aia-cas/get-pki-hierarchy-of-aia-ca-entity.md): Get a list, graph, or count of the PKI hierarchy of this AIA CA.

### Root CAs

- [Get Root CA entity info](https://bloodhound.specterops.io/reference/root-cas/get-root-ca-entity-info.md): Get info and counts for this Root CA node.
- [Get Root CA entity controllers](https://bloodhound.specterops.io/reference/root-cas/get-root-ca-entity-controllers.md): Get a list, graph, or count of the principals that can control this Root CA.
- [Get PKI hierarchy of Root CA entity](https://bloodhound.specterops.io/reference/root-cas/get-pki-hierarchy-of-root-ca-entity.md): Get a list, graph, or count of the PKI hierarchy of this Root CA.

### Enterprise CAs

- [Get Enterprise CA entity info](https://bloodhound.specterops.io/reference/enterprise-cas/get-enterprise-ca-entity-info.md): Get info and counts for this Enterprise CA node.
- [Get Enterprise CA entity controllers](https://bloodhound.specterops.io/reference/enterprise-cas/get-enterprise-ca-entity-controllers.md): Get a list, graph, or count of the principals that can control this Enterprise CA.
- [Get PKI hierarchy of Enterprise CA entity](https://bloodhound.specterops.io/reference/enterprise-cas/get-pki-hierarchy-of-enterprise-ca-entity.md): Get a list, graph, or count of the PKI hierarchy of this Enterprise CA.
- [Get published certificate templates of Enterprise CA entity](https://bloodhound.specterops.io/reference/enterprise-cas/get-published-certificate-templates-of-enterprise-ca-entity.md): Get a list, graph, or count of the published certificate templates of this Enterprise CA.

### NT Auth Stores

- [Get NT Auth Store entity info](https://bloodhound.specterops.io/reference/nt-auth-stores/get-nt-auth-store-entity-info.md): Get info and counts for this NT Auth Store node.
- [Get NT Auth Store entity controllers](https://bloodhound.specterops.io/reference/nt-auth-stores/get-nt-auth-store-entity-controllers.md): Get a list, graph, or count of the principals that can control this NT Auth Store.
- [Get trusted Enterprise CAs of NT Auth Store entity](https://bloodhound.specterops.io/reference/nt-auth-stores/get-trusted-enterprise-cas-of-nt-auth-store-entity.md): Get a list, graph, or count of the trusted Enterprise CAs of this NT Auth Store.

### Cert Templates

- [Get Cert Template entity info](https://bloodhound.specterops.io/reference/cert-templates/get-cert-template-entity-info.md): Get info and counts for this Cert Template node.
- [Get Cert Template entity controllers](https://bloodhound.specterops.io/reference/cert-templates/get-cert-template-entity-controllers.md): Get a list, graph, or count of the principals that can control this Cert Template.
- [Get Enterprise CAs having Cert Template entity published](https://bloodhound.specterops.io/reference/cert-templates/get-enterprise-cas-having-cert-template-entity-published.md): Get a list, graph, or count of the Enterprise CAs having this Cert Template published.

### OUs

- [Get OU entity info](https://bloodhound.specterops.io/reference/ous/get-ou-entity-info.md): Get info and counts for this OU node.
- [Get OU entity computers](https://bloodhound.specterops.io/reference/ous/get-ou-entity-computers.md): Get a list, graph, or count of the computers contained by this OU.
- [Get OU entity GPOs](https://bloodhound.specterops.io/reference/ous/get-ou-entity-gpos.md): Get a list, graph, or count of the GPOs that affect this OU.
- [Get OU entity groups](https://bloodhound.specterops.io/reference/ous/get-ou-entity-groups.md): Get a list, graph, or count of the groups contained by this OU.
- [Get OU entity users](https://bloodhound.specterops.io/reference/ous/get-ou-entity-users.md): Get a list, graph, or count of the users contained by this OU.

### AD Users

- [Get User entity info](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-info.md): Get info and counts for this User node.
- [Get User entity admin rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-admin-rights.md): Get a list, graph, or count of the systems this user has admin rights to.
- [Get User entity constrained delegation rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-constrained-delegation-rights.md): Get a list, graph, or count of the systems this user has constrained delegation rights to.
- [Get User entity controllables](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-controllables.md): Get a list, graph, or count of the principals this user can control.
- [Get User entity controllers](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-controllers.md): Get a list, graph, or count of the principals that can control this User.
- [Get User entity DCOM rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-dcom-rights.md): Get a list, graph, or count of the systems this user can execute DCOM on.
- [Get User entity membership](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-membership.md): Get a list, graph, or count of the groups this user is a member of.
- [Get User entity PowerShell remote rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-powershell-remote-rights.md): Get a list, graph, or count of the systems this user can execute PowerShell remote on.
- [Get User entity RDP rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-rdp-rights.md): Get a list, graph, or count of the systems this user has RDP rights to.
- [Get User entity sessions](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-sessions.md): Get a list, graph, or count of the systems this user has an active session on.
- [Get User entity SQL admin rights](https://bloodhound.specterops.io/reference/ad-users/get-user-entity-sql-admin-rights.md): Get a list, graph, or count of the systems this user has SQL admin rights to.

### Groups

- [Get Group entity info](https://bloodhound.specterops.io/reference/groups/get-group-entity-info.md): Get info and counts for this Group node.
- [Get Group entity admin rights](https://bloodhound.specterops.io/reference/groups/get-group-entity-admin-rights.md): Get a list, graph, or count of the systems this group has admin rights to.
- [Get Group entity controllables](https://bloodhound.specterops.io/reference/groups/get-group-entity-controllables.md): Get a list, graph, or count of the principals this group can control.
- [Get Group entity controllers](https://bloodhound.specterops.io/reference/groups/get-group-entity-controllers.md): Get a list, graph, or count of the principals that can control this group.
- [Get Group entity DCOMRights](https://bloodhound.specterops.io/reference/groups/get-group-entity-dcomrights.md): Get a list, graph, or count of the systems this group can execute DCOM on.
- [Get Group entity members](https://bloodhound.specterops.io/reference/groups/get-group-entity-members.md): Get a list, graph, or count of the principals that are a member of this group.
- [Get Group entity memberships](https://bloodhound.specterops.io/reference/groups/get-group-entity-memberships.md): Get a list, graph, or count of the groups this group is a member of.
- [Get Group entity PowerShell remote rights](https://bloodhound.specterops.io/reference/groups/get-group-entity-powershell-remote-rights.md): Get a list, graph, or count of the systems this group can execute PowerShell remote on.
- [Get Group entity RDP rights](https://bloodhound.specterops.io/reference/groups/get-group-entity-rdp-rights.md): Get a list, graph, or count of the systems this group can RDP to.
- [Get Group entity sessions](https://bloodhound.specterops.io/reference/groups/get-group-entity-sessions.md): Get a list, graph, or count of the active sessions for users that belong to this group.

### Data Quality

- [Get database completeness stats](https://bloodhound.specterops.io/reference/data-quality/get-database-completeness-stats.md): Get the percentage of local admins and sessions collected
- [Get AD domain data quality stats](https://bloodhound.specterops.io/reference/data-quality/get-ad-domain-data-quality-stats.md): Time series list of data quality stats for a given AD domain
- [Get Azure tenant data quality stats](https://bloodhound.specterops.io/reference/data-quality/get-azure-tenant-data-quality-stats.md): Time series list of data quality stats for a given Azure tenant
- [Get platform data quality aggregate](https://bloodhound.specterops.io/reference/data-quality/get-platform-data-quality-aggregate.md): Time series list of aggregate data quality stats for a given platform
- [Get environment-specific data quality stats](https://bloodhound.specterops.io/reference/data-quality/get-environment-specific-data-quality-stats.md): Time series list of data quality stats for a given environment
- [Get data quality aggregations by environment kind](https://bloodhound.specterops.io/reference/data-quality/get-data-quality-aggregations-by-environment-kind.md): Returns data quality metric counts aggregated per environment kind, optionally scoped to an OpenGraph schema extension, combined across environment instances for each collection run. Results can be filtered, sorted, and paginated.

### Database

- [Delete your BloodHound data](https://bloodhound.specterops.io/reference/database/delete-your-bloodhound-data.md): Wipes your BloodHound data permanently. Specify the data to delete in the request body. Possible data includes collected graph data, relationships of specific types, custom high value selectors, file ingest history, and data quality history.

### Datapipe

- [Get datapipe status](https://bloodhound.specterops.io/reference/datapipe/get-datapipe-status.md): Gets the current status of the datapipe
- [Gets analysis request information](https://bloodhound.specterops.io/reference/datapipe/gets-analysis-request-information.md): Returns the current analysis request information. Always returns 200 OK with the request details. When no request is pending, returns a zero-valued response with empty strings, false booleans, null arrays, and zero timestamp.
- [Start analysis](https://bloodhound.specterops.io/reference/datapipe/start-analysis.md): Submits an analysis request attributed to the authenticated user. The endpoint is idempotent — at most one analysis request can be pending at a time. Always returns 202 Accepted with no response body.
- [Cancels an analysis request](https://bloodhound.specterops.io/reference/datapipe/cancels-an-analysis-request.md): Flags the API to request the cancellation of analyzing ingest data.

### EULA

- [Accept EULA](https://bloodhound.specterops.io/reference/eula/accept-eula.md): Accept BloodHound Enterprise EULA for logged in user (EULA applies to BHE customers only).

### Analysis

- [Get latest tier zero combo node](https://bloodhound.specterops.io/reference/analysis/get-latest-tier-zero-combo-node.md): Get latest tier zero combo node
- [Get the graph for meta tree](https://bloodhound.specterops.io/reference/analysis/get-the-graph-for-meta-tree.md): Gets meta nodes and connecting edges
- [Get the combo tree for an asset group](https://bloodhound.specterops.io/reference/analysis/get-the-combo-tree-for-an-asset-group.md): **Deprecated**: This endpoint will no longer be supported in future releases.

### Client Ingest

- [Endpoint for data ingestion](https://bloodhound.specterops.io/reference/client-ingest/endpoint-for-data-ingestion.md): Ingests data from collector clients

### Clients

- [List Clients](https://bloodhound.specterops.io/reference/clients/list-clients.md): Lists available clients for processing collection events.
- [Create Client](https://bloodhound.specterops.io/reference/clients/create-client.md): Creates a client for collection events
- [Client Error](https://bloodhound.specterops.io/reference/clients/client-error.md): Endpoint for clients to log enumeration errors.
- [Update Client Values](https://bloodhound.specterops.io/reference/clients/update-client-values.md): Endpoint for clients to update their own information at startup.
- [Get Client](https://bloodhound.specterops.io/reference/clients/get-client.md): Gets given client for processing collection events
- [Update Client](https://bloodhound.specterops.io/reference/clients/update-client.md): Update a client for processing collection events
- [Delete Client](https://bloodhound.specterops.io/reference/clients/delete-client.md): Delete a client for processing collection events
- [Regenerate the authentication token for a client](https://bloodhound.specterops.io/reference/clients/regenerate-the-authentication-token-for-a-client.md): Regenerate the authentication token for a client
- [List all completed tasks for a client](https://bloodhound.specterops.io/reference/clients/list-all-completed-tasks-for-a-client.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/clients/{client_id}/completed_jobs` instead.
- [List all completed jobs for a client](https://bloodhound.specterops.io/reference/clients/list-all-completed-jobs-for-a-client.md): List all completed jobs for a client
- [Creates a scheduled task](https://bloodhound.specterops.io/reference/clients/creates-a-scheduled-task.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `POST /api/v2/clients/{client_id}/jobs` instead.
- [Creates a scheduled job](https://bloodhound.specterops.io/reference/clients/creates-a-scheduled-job.md): Creates a new scheduled job
- [Queues a management operation](https://bloodhound.specterops.io/reference/clients/queues-a-management-operation.md): Endpoint for users to queue a management operation for a client.
- [Download a management operation artifact for the client](https://bloodhound.specterops.io/reference/clients/download-a-management-operation-artifact-for-the-client.md): Downloads an operation artifact associated with the client.
- [Delete a management operation artifact for the client](https://bloodhound.specterops.io/reference/clients/delete-a-management-operation-artifact-for-the-client.md): Deletes an operation artifact associated with the client.
- [Get available management operations](https://bloodhound.specterops.io/reference/clients/get-available-management-operations.md): Endpoint for clients to get next available management operations.
- [Notifies the API of a management operation start](https://bloodhound.specterops.io/reference/clients/notifies-the-api-of-a-management-operation-start.md): Endpoint for clients to start a management operation and mark the start time.
- [Notifies the API of a management operation ending](https://bloodhound.specterops.io/reference/clients/notifies-the-api-of-a-management-operation-ending.md): Endpoint for clients to end a management operation and mark the completed time.
- [Create an artifact upload session](https://bloodhound.specterops.io/reference/clients/create-an-artifact-upload-session.md): Endpoint for clients to create an artifact upload session and associate it with a running management operation.
- [Get an artifact upload session](https://bloodhound.specterops.io/reference/clients/get-an-artifact-upload-session.md): Endpoint for clients to get artifact upload-session state.
- [Upload an artifact part](https://bloodhound.specterops.io/reference/clients/upload-an-artifact-part.md): Endpoint for clients to upload one part of an artifact upload session.
- [Complete an artifact upload session](https://bloodhound.specterops.io/reference/clients/complete-an-artifact-upload-session.md): Endpoint for clients to complete an artifact upload session after all expected parts have been uploaded.
- [Get a client artifact download URL](https://bloodhound.specterops.io/reference/clients/get-a-client-artifact-download-url.md): Issues a presigned URL that can be used to download an operation artifact associated with the client
- [Download a management operation artifact for the client](https://bloodhound.specterops.io/reference/clients/download-a-management-operation-artifact-for-the-client-1.md): Downloads an operation artifact associated with the client using a previously issued artifact download token.

### Jobs

- [List available client jobs](https://bloodhound.specterops.io/reference/jobs/list-available-client-jobs.md): Endpoint for clients to get next available jobs.
- [List finished jobs](https://bloodhound.specterops.io/reference/jobs/list-finished-jobs.md): Gets all finished jobs
- [Get jobs](https://bloodhound.specterops.io/reference/jobs/get-jobs.md): Gets client jobs
- [Get client current job](https://bloodhound.specterops.io/reference/jobs/get-client-current-job.md): Gets the current job for the authenticated client.
- [Notifies the API of a job start](https://bloodhound.specterops.io/reference/jobs/notifies-the-api-of-a-job-start.md): Endpoint for clients to start a new job and mark the start time.
- [Notifies the API of a job ending](https://bloodhound.specterops.io/reference/jobs/notifies-the-api-of-a-job-ending.md): Endpoint for clients to end a job and mark the end time.
- [Get client job](https://bloodhound.specterops.io/reference/jobs/get-client-job.md): Gets client job
- [Cancels a scheduled job](https://bloodhound.specterops.io/reference/jobs/cancels-a-scheduled-job.md): Cancels a scheduled job
- [Get Job Log File](https://bloodhound.specterops.io/reference/jobs/get-job-log-file.md): Get the log file from a SharpHound run

### Tasks

- [List available client tasks](https://bloodhound.specterops.io/reference/tasks/list-available-client-tasks.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs/available` instead.
- [List finished tasks](https://bloodhound.specterops.io/reference/tasks/list-finished-tasks.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs/finished` instead.
- [Get tasks](https://bloodhound.specterops.io/reference/tasks/get-tasks.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs` instead.
- [Get client current task](https://bloodhound.specterops.io/reference/tasks/get-client-current-task.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs/current` instead.
- [Notifies the API of a task start](https://bloodhound.specterops.io/reference/tasks/notifies-the-api-of-a-task-start.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `POST /api/v2/jobs/start` instead.
- [Notifies the API of a task ending](https://bloodhound.specterops.io/reference/tasks/notifies-the-api-of-a-task-ending.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `POST /api/v2/jobs/end` instead.
- [Get client task](https://bloodhound.specterops.io/reference/tasks/get-client-task.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs/{job_id}` instead.
- [Cancels a scheduled task](https://bloodhound.specterops.io/reference/tasks/cancels-a-scheduled-task.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `PUT /api/v2/jobs/{job_id}/cancel` instead.
- [Get Task Log File](https://bloodhound.specterops.io/reference/tasks/get-task-log-file.md): **Deprecated**: This endpoint will no longer be supported in future releases. Please use `GET /api/v2/jobs/{job_id}/log` instead.

### Events (Schedules)

- [List events](https://bloodhound.specterops.io/reference/events-schedules/list-events.md): Gets all client scheduled events.
- [Create Event](https://bloodhound.specterops.io/reference/events-schedules/create-event.md): Creates a scheduled event for data collection
- [Get Event](https://bloodhound.specterops.io/reference/events-schedules/get-event.md): Gets a scheduled job event by ID.
- [Update Event](https://bloodhound.specterops.io/reference/events-schedules/update-event.md): Updates a scheduled event
- [Delete Event](https://bloodhound.specterops.io/reference/events-schedules/delete-event.md): Deletes a scheduled event and associated tasks by id

### Attack Paths

- [Export attack path findings](https://bloodhound.specterops.io/reference/attack-paths/export-attack-path-findings.md): Export the finding table for a given attack path
- [List finding trends](https://bloodhound.specterops.io/reference/attack-paths/list-finding-trends.md): Lists findings and their changes in between two dates for an environment
- [List all attack path types](https://bloodhound.specterops.io/reference/attack-paths/list-all-attack-path-types.md): Lists all possible attack path types
- [List attack path finding types](https://bloodhound.specterops.io/reference/attack-paths/list-attack-path-finding-types.md): Returns distinct attack path finding types available to the caller. Results are always returned in ascending order by `title`.
- [Start analysis](https://bloodhound.specterops.io/reference/attack-paths/start-analysis.md): Starts generating attack paths
- [Get all attack path findings](https://bloodhound.specterops.io/reference/attack-paths/get-all-attack-path-findings.md): Fetches all attack path findings and their associated details, including documentation.
- [List attack path findings](https://bloodhound.specterops.io/reference/attack-paths/list-attack-path-findings.md): Returns a unified, paginated list of attack path findings. Defaults to active findings of both relationship and list types unless filtered otherwise.
- [List available attack paths](https://bloodhound.specterops.io/reference/attack-paths/list-available-attack-paths.md): Lists available attack path types for a domain
- [List domain attack paths details](https://bloodhound.specterops.io/reference/attack-paths/list-domain-attack-paths-details.md): Lists detailed data about attack paths for a domain.
- [List attack path sparkline values](https://bloodhound.specterops.io/reference/attack-paths/list-attack-path-sparkline-values.md): List the values that represent the sparklines for individual attack paths
- [Update attack path risk](https://bloodhound.specterops.io/reference/attack-paths/update-attack-path-risk.md): Updates an attack path as an accepted or unaccepted risk until a given time.

### Risk Posture

- [Get Posture Statistics](https://bloodhound.specterops.io/reference/risk-posture/get-posture-statistics.md): Gets the history of database stats saved in the database
- [Get Posture History](https://bloodhound.specterops.io/reference/risk-posture/get-posture-history.md): Gets posture data count changes over a time period

### Asset Scores

- [Get zone protected asset score](https://bloodhound.specterops.io/reference/asset-scores/get-zone-protected-asset-score.md): Gets a per-day series describing how much of a zone is free of open findings over the requested time range. For each day in the range, the score is the number of objects in the zone without an open finding divided by the total number of objects in the zone. Zones that attack path analysis does not r…

### Meta Entities

- [Get Meta entity info](https://bloodhound.specterops.io/reference/meta-entities/get-meta-entity-info.md): Get info and counts for this Meta node.

### Alerts

- [List Alert Webhooks](https://bloodhound.specterops.io/reference/alerts/list-alert-webhooks.md): Returns a paginated list of alert webhooks.
- [Create Alert Webhook](https://bloodhound.specterops.io/reference/alerts/create-alert-webhook.md): Creates a new alert webhook (channel + webhook + HMAC secret in one transaction). The generated HMAC secret is returned on this response only.
- [Get Alert Webhook](https://bloodhound.specterops.io/reference/alerts/get-alert-webhook.md): Returns a single alert webhook by ID.
- [Delete Alert Webhook](https://bloodhound.specterops.io/reference/alerts/delete-alert-webhook.md): Deletes an alert webhook. Cascades to `alert_webhook_secrets`, `alert_subscriptions`, and `alert_attempts` rows that reference this webhook.
- [Update Alert Webhook](https://bloodhound.specterops.io/reference/alerts/update-alert-webhook.md): Partially updates an alert webhook by ID. Only fields present in the request body are modified.
- [Rotate Alert Webhook Secret](https://bloodhound.specterops.io/reference/alerts/rotate-alert-webhook-secret.md): Generates a new HMAC secret for an alert webhook. The new plaintext secret is returned on this response only and replaces the prior secret.
- [Test Alert Webhook](https://bloodhound.specterops.io/reference/alerts/test-alert-webhook.md): Synchronously dispatches a mock payload for the given `event_type` to the webhook's target URL using the current HMAC secret. No `alert_attempts` row is persisted. The handler returns `200` for both successful and failed upstream deliveries; the `status_code` and `error` fields in the response body…
- [List Alert Events](https://bloodhound.specterops.io/reference/alerts/list-alert-events.md): Returns a paginated list of alert events. Events are system-generated and read-only via the API.
- [Get Alert Event](https://bloodhound.specterops.io/reference/alerts/get-alert-event.md): Returns a single alert event by ID.
- [List Alert Event Types](https://bloodhound.specterops.io/reference/alerts/list-alert-event-types.md): Returns the list of alert event types registered with the system along with the payload schema versions supported for each type. The response is not paginated or filtered.
- [List Alerts](https://bloodhound.specterops.io/reference/alerts/list-alerts.md): Returns a paginated list of alerts with their embedded subscriptions.
- [Create Alert](https://bloodhound.specterops.io/reference/alerts/create-alert.md): Creates a new alert with the supplied subscription bindings. The `subscriptions` array is required but may be empty.
- [Get Alert](https://bloodhound.specterops.io/reference/alerts/get-alert.md): Returns a single alert by ID with its embedded subscriptions.
- [Delete Alert](https://bloodhound.specterops.io/reference/alerts/delete-alert.md): Deletes an alert. Cascades to `alert_subscriptions` and `alert_attempts` rows referencing this alert.
- [Update Alert](https://bloodhound.specterops.io/reference/alerts/update-alert.md): Partially updates an alert by ID. All top-level fields are optional. If `subscriptions` is present, the supplied array fully replaces the current subscription set for this alert in one transaction (delete-omitted, insert-new, update-existing by composite key `(channel_id, event_type)`). Omit `subscr…
- [List Alert Attempts](https://bloodhound.specterops.io/reference/alerts/list-alert-attempts.md): Returns a paginated list of alert delivery attempts. Composite-key filters (`alert_id`, `channel_id`, `event_id`) compose to support per-alert, per-webhook, per-event, and single-row views.
- [Retry Alert Attempt](https://bloodhound.specterops.io/reference/alerts/retry-alert-attempt.md): Manually re-queues an existing alert delivery attempt. The composite key in the request body identifies the specific attempt (alert, event, channel/webhook) to retry. The attempt is ignored when the attempt has already succeeded.

## OpenAPI Specs

- [openapi](/openapi.json)