Skip to main content
GET
/
api
/
v2
/
asset-group-tags
Get Asset Group Tags
curl --request GET \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "tags": [
      {
        "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://bloodhound.specterops.io/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

​
type
string

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

Pattern: ^((eq|neq):)?-?[0-9]+$
​
counts
boolean
default:false

Whether to include counts of selectors and members for each tag

​
name
string

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

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

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

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

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$
​
created_by
string

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

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

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$
​
updated_by
string

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

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

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Pattern: ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$
​
deleted_by
string

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

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

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

Pattern: ^((eq|neq):)?(t|T|TRUE|true|True|f|F|FALSE|false|False)$

Response

OK

​
data
object