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

Operations about Users

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

Tagged areas include Users. 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 Users 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.

Users 5

Operations about Users

GET
/v1/memberships
List Memberships
getV1Memberships 7 params → 200403
POST
/v1/memberships
Create a Membership
MembershipCreationParameters 1 param → 201400403404422
GET
/v1/memberships/{id}
Get Membership
getV1MembershipsId 1 param → 200403
DELETE
/v1/memberships/{id}
Delete Membership
deleteV1MembershipsId 1 param → 202403404422
PATCH
/v1/memberships/{id}
Update a User's membership
MembershipUpdateParameters 2 params → 200400403422

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Membership (7 properties), MembershipCreationParameters (5 properties), MemberInvitation (4 properties), Pagination (2 properties). Each schema is shown below with its type and property counts.

MemberInvitation
object
MemberInvitation model
4 properties
MembershipUpdateParameters
object
Update a User's membership
1 property
Pagination
object
Pagination model
2 properties
Membership
object
Membership model
7 properties
MembershipCreationParameters
object
Create a Membership
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huntress-users-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