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

Operations about Organizations

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

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

This API exposes 5 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.

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

Paths & Operations 5

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

Organizations 5

Operations about Organizations

GET
/v1/organizations
List Organizations
getV1Organizations 6 params → 200403
POST
/v1/organizations
Create an Organization
OrganizationCreationParameters 1 param → 201400403422
GET
/v1/organizations/{id}
Get Organization
getV1OrganizationsId 1 param → 200403
PATCH
/v1/organizations/{id}
Update an Organization
OrganizationUpdateParameters 2 params → 200400403422
DELETE
/v1/organizations/{id}
Delete an Organization
deleteV1OrganizationsId 1 param → 202403404409422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OrganizationWithActualProductUsages (14 properties), Organization (13 properties), OrganizationUpdateParameters (3 properties), OrganizationCreationParameters (2 properties). Each schema is shown below with its type and property counts.

OrganizationUpdateParameters
object
Update an Organization
3 properties
Organization
object
Organization model
13 properties 3 required
OrganizationWithActualProductUsages
object
OrganizationWithActualProductUsages model
14 properties 3 required
Pagination
object
Pagination model
2 properties
OrganizationCreationParameters
object
Create an Organization
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huntress-organizations-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 Platform Actions API
Huntress Reseller API
Huntress SIEM API