Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Huntress Summary Reports API

Operations about Summary Reports

Huntress Summary Reports API is one of 17 APIs that Huntress publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Summary Reports. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://api.huntress.io/v1.

2 operations 2 paths 5 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://api.huntress.io/v1
Authentication
basic
Resource Areas
1

Authentication & Security 1

Huntress Summary Reports API declares 1 security scheme for authenticating requests. It defines a basic scheme (basic_auth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Summary Reports 2

Operations about Summary Reports

GET
/v1/reports
List Summary Reports
getV1Reports 8 params → 200403
GET
/v1/reports/{id}
Get Summary Report
getV1ReportsId 1 param → 200403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SummaryReport (80 properties), ReportIncident (6 properties), ReportIncidentRemediation (2 properties), ReportExternalService (2 properties). Each schema is shown below with its type and property counts.

Pagination
object
Pagination model
2 properties
ReportExternalService
object
2 properties
ReportIncident
object
6 properties
SummaryReport
object
SummaryReport model
80 properties
ReportIncidentRemediation
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huntress-summary-reports-api-openapi.yml Raw ↑

Other APIs Huntress publishes across the network.

Huntress Accounts API
Huntress Actor API
Huntress Agents API
Huntress Escalations API
Huntress External Recon API
Huntress Identities API
Huntress Incident Reports API
Huntress Invoices API
Huntress Known VPNs API
Huntress Organizations API
Huntress Platform Actions API
Huntress Reseller API