Skip to main content
GET
/
api
/
v2
/
file-upload
Error
A valid request URL is required to generate request examples
{
  "count": 1,
  "skip": 1,
  "limit": 1,
  "data": [
    {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": {
        "time": "2023-11-07T05:31:56Z",
        "valid": true
      },
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_email_address": "[email protected]",
      "status": -1,
      "status_message": "<string>",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "last_ingest": "2023-11-07T05:31:56Z",
      "total_files": 123,
      "failed_files": 123
    }
  ]
}
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

Query Parameters

​
sort_by
string

Sortable columns are user_email_address, status, status_message, start_time, end_time, last_ingest, id, created_at, updated_at, and deleted_at.

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

​
user_id
string

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

​
user_email_address
string

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

​
status
integer

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

​
status_message
string

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

​
start_time
string<date-time>

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

​
end_time
string<date-time>

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

​
last_ingest
string<date-time>

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

​
id
integer

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

​
created_at
string<date-time>

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

​
updated_at
string<date-time>

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

​
deleted_at
string<date-time>

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

​
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

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[]