Skip to main content
GET
/
api
/
v2
/
available-domains
Get available domains
curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/available-domains \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "<string>",
      "name": "<string>",
      "id": "<string>",
      "collected": true,
      "impactValue": 123,
      "hygiene_attack_paths": 123,
      "exposures": [
        {
          "exposure_percent": 123,
          "asset_group_tag": {
            "id": 123,
            "type": 123,
            "kind_id": 123,
            "name": "<string>",
            "description": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "created_by": "<string>",
            "updated_at": "2023-11-07T05:31:56Z",
            "updated_by": "<string>",
            "position": {
              "int32": 123,
              "valid": true
            },
            "require_certify": {
              "bool": true,
              "valid": true
            },
            "analysis_enabled": {
              "bool": true,
              "valid": true
            },
            "glyph": {
              "string": "<string>",
              "valid": true
            }
          }
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://specterops-bp-2510-sharphound-collection.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Applies to BloodHound Enterprise and CE

Authorizations

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

Query Parameters

​
sort_by
string

Sortable columns are objectid, name. Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
objectid
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
name
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$
​
collected
string

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

Pattern: ^((eq|~eq|neq):)?[^:]+$

Response

OK

​
data
object[]