Search Asset Group Tags

Supports searching by name on asset group tags and selectors, and by name or object ID on members.

POST /api/v2/asset-group-tags/search

Search Asset Group Tags

cURL

curl --request POST \
  --url https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "tag_type": 123,
  "asset_group_tag_id": 123
}
'

import requests

url = "https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search"

payload = {
    "query": "<string>",
    "tag_type": 123,
    "asset_group_tag_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({query: '<string>', tag_type: 123, asset_group_tag_id: 123})
};

fetch('https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '<string>',
    'tag_type' => 123,
    'asset_group_tag_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"tag_type\": 123,\n  \"asset_group_tag_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"tag_type\": 123,\n  \"asset_group_tag_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your-tenant.bloodhoundenterprise.io/api/v2/asset-group-tags/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"tag_type\": 123,\n  \"asset_group_tag_id\": 123\n}"

response = http.request(request)
puts response.read_body

200

{
  "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
        }
      }
    ],
    "selectors": [
      {
        "id": 123,
        "asset_group_tag_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "created_by": "<string>",
        "updated_at": "2023-11-07T05:31:56Z",
        "updated_by": "<string>",
        "disabled_at": "2023-11-07T05:31:56Z",
        "disabled_by": "<string>",
        "name": "<string>",
        "description": "<string>",
        "is_default": true,
        "allow_disable": true,
        "seeds": [
          {
            "value": "<string>"
          }
        ]
      }
    ],
    "members": [
      {
        "id": 123,
        "object_id": "<string>",
        "environment_id": "<string>",
        "primary_kind": "<string>",
        "name": "<string>",
        "properties": {},
        "source": 123
      }
    ]
  }
}

{
  "http_status": 400,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The JSON payload could not be unmarshalled."
    }
  ]
}

{
  "http_status": 401,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "login",
      "message": "Unauthorized"
    }
  ]
}

{
  "http_status": 403,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "You do not have permission to access this resource"
    }
  ]
}

{
  "http_status": 404,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The requested client could not be found."
    }
  ]
}

{
  "http_status": 429,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "middleware",
      "message": "Too many requests. Please try again later."
    }
  ]
}

{
  "http_status": 500,
  "timestamp": "2024-02-19T19:27:43.866Z",
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "errors": [
    {
      "context": "clients",
      "message": "The request could not be handled due to an unexpected database error."
    }
  ]
}

Authorizations

JWTBearerTokenSignedRequest & RequestDate & HMACSignature

Authorization · string · header · required

Authorization: Bearer $JWT_TOKEN

Body

application/json

The request body for searching asset group tags. query represents being able to query by either name or object id. tag_type can be either 1(zone), 2(label), or 3(owned). And asset_group_tag_id is the ID of a tag (zone or label).

query · string · required

tag_type · integer · required

asset_group_tag_id · integer

Response

200

application/json

OK

data · object

Show child attributes