Skip to main content
GET
/
api
/
v2
/
containers
/
{object_id}
/
controllers
Error
A valid request URL is required to generate request examples
{
  "count": 1,
  "skip": 1,
  "limit": 1,
  "data": [
    {
      "objectID": "<string>",
      "name": "<string>",
      "label": "<string>",
      "kinds": [
        "<string>"
      ]
    }
  ]
}
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

​
object_id
string
required

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

Query Parameters

​
skip
integer
default:0

The number of entries to skip for pagination. Only available for type=list.

Required range: x >= 0
​
limit
integer
default:10

The number of entries to limit in the response. Only available for type=list.

Required range: x >= 0
​
type
enum<string>
default:list

The type of return data requested. If no type is provided, query will default to list. The only supported type is list, but the unsupported graph type can be used. Some entity query endpoints do not support the graph type. For those interested in using the undocumented graph type parameter, the response type is described in the schema model.bh-graph.graph.

Available options:
list,
graph
​
sort_by
string

Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind.

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

Response

OK

This endpoint returns a response, dependent upon which return type is requested by the type parameter. The only supported type parameter is list. While list is the only supported type parameter, the graph parameter can be used and will result in a different response structure then documented here. For those interested in using the undocumented graph type parameter, the response type is described in the schema model.bh-graph.graph.

​
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
paged-node-list-entry · object[]