Skip to main content
GET
/
api
/
v2
/
azure
/
{entity_type}
Error
A valid request URL is required to generate request examples
{
  "data": {
    "kind": "<string>",
    "properties": {}
  }
}
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

​
entity_type
string
required

Entity Type

Query Parameters

​
object_id
string
required

The object ID of the entity being operated on.

​
counts
boolean

Returns related entity counts. Does not work with related_entity_type parameter.

​
related_entity_type
string

Flags the query to return related entity information based on the type passed.

​
type
enum<string>
default:list

The type of return data expected. Only works with related_entity_type parameter.

Available options:
list,
graph
​
skip
integer

This query parameter is used for determining the number of objects to skip in pagination. Only compatible with related_entity_type and type=list

The number of items to skip in a paginated response.

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

This query parameter is used for setting an upper limit of objects returned in paginated responses. Only compatible with related_entity_type and type=list

The limit of results requested by the client.

Required range: x >= 0

Response

This endpoint returns a polymorphic response dependent on the query parameters passed. Three different response schemas are possible:

  • entity schema is used when related_entity_type is not set. Additional 'count' properties are dependent on the type of entity being queried.
  • related-list schema is used when related_entity_type is set and type parameter is either list or not set (it is the default), and it supports pagination.
  • related-graph schema is used when related_entity_type is set and type=graph.

This response is used when related_entity_type is not set. It returns information about a single node. All node types will return with the basic node fields, but the additional count properties are dependent on the kind of node returned. Setting counts=true will populate those count details at the cost of performance.

​
data
object