Skip to main content
PATCH
/
api
/
v2
/
asset-group-tags
/
{asset_group_tag_id}
Update Asset Group Tag
curl --request PATCH \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/{asset_group_tag_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "require_certify": true,
  "position": 123
}
'
{
  "data": {
    "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-2395-ms-sentinel.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]+)$

Path Parameters

​
asset_group_tag_id
integer<int32>
required

ID of an asset group tag

Body

application/json

The request body for updating an asset group tag. At least one field is required.

​
name
string

Only alphanumeric characters, underscores, and spaces are allowed.

​
description
string
​
require_certify
boolean
​
position
integer

Response

OK

​
data
object