Update the Domain entity

Updates the supported properties on the Domain entity.

PATCH /api/v2/domains/{object_id}

Update the Domain entity

cURL

curl --request PATCH \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/domains/{object_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collected": true
}
'

200

{
  "data": {
    "collected": true
  }
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Headers

Prefer · string · default: wait=30

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. Passing in wait=-1 bypasses all timeout limits when the feature is enabled.

Pattern: ^wait=(-1|[0-9]+)$

Path Parameters

object_id · string · required

The object id of the entity being operated on. The unique object identifier

Body

application/json

The patch request body for updating Domain

collected · boolean

Response

200

application/json

OK

data · object

Show child attributes