Skip to main content
GET
/
api
/
v2
/
asset-groups
/
{asset_group_id}
/
members
Error
A valid request URL is required to generate request examples
{
  "count": 1,
  "skip": 1,
  "limit": 1,
  "data": {
    "members": [
      {
        "asset_group_id": 123,
        "object_id": "<string>",
        "primary_kind": "<string>",
        "kinds": [
          "<string>"
        ],
        "environment_id": "<string>",
        "environment_kind": "<string>",
        "name": "<string>",
        "custom_member": true
      }
    ]
  }
}
Applies to BloodHound Enterprise and CE

Authorizations

​
Authorization
string
header
required

Authorization: Bearer $JWT_TOKEN

Headers

​
Prefer
integer
default:0

Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240.

Required range: x >= 0

Path Parameters

​
asset_group_id
integer<int32>
required

ID of the asset_group record to retrieve

Query Parameters

​
skip
integer

This query parameter is used for determining the number of objects to skip in pagination. The number of items to skip in a paginated response.

Required range: x >= 0
​
limit
integer

This query parameter is used for setting an upper limit of objects returned in paginated responses. The limit of results requested by the client.

Required range: x >= 0
​
sort_by
string

Sortable columns are object_id, asset_group_id, primary_kind, environment_id, environment_kind, and name.

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

​
object_id
string

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

​
primary_kind
string

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

​
environment_id
string

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

​
environment_kind
string

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

​
name
string

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

​
custom_member
string

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

Response

OK

​
count
integer

The total number of results.

Required range: x >= 0
​
skip
integer

The number of items to skip in a paginated response.

Required range: x >= 0
​
limit
integer

The limit of results requested by the client.

Required range: x >= 0
​
data
object