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 Agents API

Operations about Agents

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

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

This API exposes 6 operations across 3 paths, and defines 4 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.

6 operations 3 paths 4 schemas 2 DELETE2 GET1 PATCH1 POST

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 Agents API declares 1 security scheme for authenticating requests. It defines a basic scheme (basic_auth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Agents 6

Operations about Agents

GET
/v1/agents
List Agents
getV1Agents 9 params → 200403
GET
/v1/agents/{id}
Get Agent
getV1AgentsId 1 param → 200403
PATCH
/v1/agents/{id}
Update Agent
UpdateAgent 2 params → 200403404409
DELETE
/v1/agents/{id}
Uninstall Agent
UninstallAgent 1 param → 204403404
POST
/v1/agents/{id}/isolation
Isolate Agent
IsolateAgent 2 params → 201403404409
DELETE
/v1/agents/{id}/isolation
Release Agent Isolation
ReleaseAgent 1 param → 204404409

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Agent (33 properties), IsolateAgent (2 properties), Pagination (2 properties), UpdateAgent (2 properties). Each schema is shown below with its type and property counts.

UpdateAgent
object
Update Agent
2 properties
Pagination
object
Pagination model
2 properties
Agent
object
Agent model
33 properties
IsolateAgent
object
Isolate Agent
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huntress-agents-api-openapi.yml Raw ↑

Other APIs Huntress publishes across the network.

Huntress Accounts API
Huntress Actor 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
Huntress SIEM API