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 Unwanted Access Rules API

Operations about Unwanted Access Rules

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

Tagged areas include Unwanted Access Rules. 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 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.

5 operations 2 paths 4 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 Unwanted Access Rules 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.

Unwanted Access Rules 5

Operations about Unwanted Access Rules

GET
/v1/unwanted_access_rules
List Unwanted Access Rules
getV1UnwantedAccessRules 12 params → 200400403
POST
/v1/unwanted_access_rules
Create an Unwanted Access Rule
UnwantedAccessRuleCreationParameters 1 param → 201400403404422
GET
/v1/unwanted_access_rules/{id}
Get Unwanted Access Rule
getV1UnwantedAccessRulesId 1 param → 200403404
DELETE
/v1/unwanted_access_rules/{id}
Delete Unwanted Access Rule
deleteV1UnwantedAccessRulesId 1 param → 202403404422
PATCH
/v1/unwanted_access_rules/{id}
Update an Unwanted Access Rule
UnwantedAccessRuleUpdateParameters 2 params → 200400403404422

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UnwantedAccessRule (15 properties), UnwantedAccessRuleCreationParameters (10 properties), UnwantedAccessRuleUpdateParameters (3 properties), Pagination (2 properties). Each schema is shown below with its type and property counts.

Pagination
object
Pagination model
2 properties
UnwantedAccessRuleCreationParameters
object
Create an Unwanted Access Rule
10 properties 1 required
UnwantedAccessRuleUpdateParameters
object
Update an Unwanted Access Rule
3 properties
UnwantedAccessRule
object
UnwantedAccessRule model
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huntress-unwanted-access-rules-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