Huntress Unwanted Access Rules API
Operations about Unwanted Access Rules
OpenAPI Specification
swagger: '2.0'
info:
title: Huntress API Reference Accounts Unwanted Access Rules API
description: "<!-- DO NOT LINT FOR FORMATTING, you will break how it appears on the docs site -->\n<p><a href='https://www.huntress.com/terms-of-service'>© Huntress - All rights reserved</a></p>\n<h1 id='introduction'>Introduction</h1>\n\n<p>Webhook event payloads are available via the dropdown menu above the search bar on this page.</p>\n\n<p>The Huntress API follows a RESTful pattern. Requests are made via resource-oriented URLs as described in this document and API responses are formatted as JSON data.</p>\n\n<p>A command-line client is also available for interacting with the API from your terminal. It requires Ruby 3.1+ and has no external dependencies. You can download it from <a href='https://api.huntress.io/api/huntress-cli'>https://api.huntress.io/api/huntress-cli</a>.</p>\n\n<p>Alternatively, if you'd prefer to use an MCP, we have <a href=\"https://support.huntress.io/hc/en-us/articles/50846554117395-Connecting-to-the-Huntress-MCP-Server\">instructions for setting up the Huntress MCP</a>. Note that the MCP is read-only, so this is a good option if you're looking for a safer way to access your Huntress data from an LLM.</p>\n\n<p>If you'd like to request additional API endpoints or capabilities, <a href=\"https://feedback.huntress.com/\">submit feedback</a> through our feedback portal.</p>\n\n<h1 id='api-overview'>API Overview</h1>\n<details>\n\t<summary><h2 id='authentication'>Authentication</h2></summary>\n<div class=\"scalar-code-copy\"><pre class=\"scalar-codeblock-pre\"><code class=\"hljs language-curl\"><span class=\"hljs-variable\">$KEY</span> = </span><span class=\"hljs-built_in\">echo </span><span class=\"hljs-string\">\"$HUNTRESS_PUBLIC_KEY:$HUNTRESS_PRIVATE_KEY\"</span> | <span class=\"hljs-built_in\">base64</span>\n<span class=\"hljs-built_in\">curl </span><span class=\"hljs-string\">\"https://api.huntress.io/v1/agents\"</span> \\ -H <span class=\"hljs-string\">\"Authorization: Basic $KEY\"</span>\n</code></pre>\n</div>\n<p>To begin, generate your API Key at <code><your_account_subdomain>.huntress.io</code>. Once you are logged into your account on the Huntress site, check the dropdown menu at the top-right corner of the site header. You should see <code>API Credentials</code> among the options if your account has been granted access to the Huntress API. Click on the option to continue to the API Key generation page.</p>\n\n<p>Once on the API Key generation page, click on the green Setup button to begin the process to generate your API Key. You will be redirected to a page where you will be prompted to generate your API Key. Click the Generate button to generate a public and private key pair for Huntress API access. The inputs on the page will be filled in with your access credentials once you have done so.</p>\n\n<p><strong>Your API Private Key will only be visible at this stage of API Key generation. Be sure to save the value provided somewhere secure, as once you navigate away from this page, this value will no longer be accessible and you must regenerate your API credentials if your secret key value is lost.</strong></p>\n\n<p>If necessary, you can repeat the process to regenerate your API credentials with a new API Key and API Secret Key on the same API Key generation page, at <code><your_account_subdomain>.huntress.io/account/api_credentials</code>.</p>\n\n<p>The Huntress API implements basic access authentication. Once you have your API Key and API Secret Key, provide these values as the result of a Base64 encoded string in every request to the Huntress API via the <code>Authorization</code> header. Your request header should look something like <code>Authorization: Basic [Base64Encode(<your_api_key>:<your_api_secret_key>)]</code>. Please refer to the code snippets for further examples.</p>\n</details>\n<details>\n\t<summary><h2 id='rate-limits'>Rate Limits</h2></summary>\n<p>Every Huntress API account is rate limited to 60 requests per minute, on a sliding window. This means that no more than 60 requests can be made within a 60 second time interval between the first request and the last request.</p>\n\n<p>For example, if request 1 is made at T0, request 2 is made at T5, and requests 3 through 60 are made at T10, making request 61 at T55 would result in a 429 error response. Making request 61 at T61 would succeed, however making request 62 at T61 would fail, at least until the time has passed T65, corresponding to a minute after request 2 was made.</p>\n</details>\n<details>\n\t<summary><h2 id='http-response-codes'>HTTP Response Codes</h2></summary>\n<p>Huntress follows HTTP standards when delivering responses: a <code>2xx</code> response is a success, a <code>4xx</code> response indicates an issue with the client request, and a <code>5xx</code> response indicates an issue with Huntress servers.\n<br>\n<br>\nSpecific error codes are detailed in the following table:</p>\n<table><thead>\n<tr>\n<th>Error Status Code</th>\n<th>Details</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>400</td>\n<td>There is an unexpected value in the API request being made.</td>\n</tr>\n<tr>\n<td>401</td>\n<td>Your request could not be authenticated. Check that your API key is properly formatted and included in the <code>Authorization</code> header.</td>\n</tr>\n<tr>\n<td>404</td>\n<td>The requested resource is unavailable: either it doesn't exist, or your account does not hold correct permissions to access it.</td>\n</tr>\n<tr>\n<td>429</td>\n<td>You have made too many requests within the rate limit timeframe. See the previous section on <a href=\"#rate_limits\">rate_limits</a> for details.</td>\n</tr>\n<tr>\n<td>500</td>\n<td><p>An error has occurred within Huntress servers.</p><p>You could retry the request, but if you encounter continued errors, please <a href=\"https://support.huntress.io\">contact Support</a> with details of your error. If all traffic from Huntress is resulting in 500 responses, please check our <a href=\"https://huntressstatus.statuspage.io/\">Huntress Status Page</a>.</p></td>\n</tr>\n</tbody></table>\n</details>\n<details>\n\t<summary><h2 id='pagination'>Pagination</h2></summary>\n<p>Certain Huntress API endpoints utilize a <code>page_token</code> and <code>limit</code> parameter to specify a window location and size, respectively, to the resources currently being requested.\n<br><br>\nEach API request will also return a pagination object with details about your current pagination state based on the parameters provided. The pagination object contains:<br></p>\n\n<table><thead>\n<tr>\n<th>Key</th>\n<th>Type</th>\n<th>Description</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>next_page_token</td>\n<td>string</td>\n<td>The token used to request the next page in paginated results. If no page token is included, the first page contains all results.</td>\n</tr>\n<tr>\n<td>next_page_url</td>\n<td>string</td>\n<td>URL containing the next page and the limit provided in the original API request, to be used to continue sequentially accessing resources. Only displays when another page can be accessed.</td>\n</tr>\n</tbody></table>\n<br>\n<p>Following is a formatted example of the pagination object in an API response:<br>\n<div class=\"scalar-code-copy\">\n<pre class=\"scalar-codeblock-pre\">\n<code class=\"hljs language-json\"><span class=\"hljs-attr\">\"pagination\"</span><span class=\"hljs-punctuation\">: {</span>\n<span class=\"hljs-attr\"> \"next_page_url\"</span><span class=\"hljs-punctuation\">: </span><span class=\"hljs-string\">\"https://api.huntress.io/v1/agents?page_token=MjAyMi0wMy0wMVQxODo1NDoyNFo&limit=10\"</span><span class=\"hljs-punctuation\">,\n</span><span class=\"hljs-attr\"> \"next_page_token\"</span><span class=\"hljs-punctuation\">: </span><span class=\"hljs-string\">\"MjAyMi0wMy0wMVQxODo1NDoyNFo\"</span><span class=\"hljs-punctuation\">\n}</span></code></pre>\n</div>\n</details>\n<details>\n\t<summary><h2 id='request-and-response-format'>Request and Response Format</h2></summary>\n\t<details>\n\t\t<summary><h3 id='request'>Request</h3></summary>\n\t<div class=\"scalar-code-copy\">\n<pre class=\"scalar-codeblock-pre\">\n<code class=\"hljs language-curl\"><span class=\"hljs-built_in\">curl</span> <span class=\"hljs-string\">\"https://api.huntress.io/v1/agents?organization_id=1&page_token=MjAyMi0wMy0wMVQxODo1NDoyNFo\"</span> -H <span class=\"hljs-string\">\"Authorization: Basic <Your B64 encoded hash>\"</span></code></pre></div>\n\t<p>The base URL for API requests is <code>api.huntress.io/v1/</code>, followed by the resource requested. Resources can be requested either singularly or as a list, which correspond to <code>/v1/<resources>/:id</code> or <code>/v1/<resources></code> respectively, with the exception of the <code>/v1/account</code> and <code>/v1/actor</code> endpoints, which only returns the account associated with the API credentials provided.</p>\n\t<p>As an example, <code>api.huntress.io/v1/agents</code> would return a list of agents, while <code>api.huntress.io/v1/agents/1</code> would return a singular agent with ID: 1.</p>\n\t<p>Parameters are provided to the API through a query string. As an example, providing the organization_id filter as a parameter to the <code>/v1/agents</code> endpoint would look like <code>api.huntress/io/v1/agents?organization_id=1</code>. Accessing a sequential page with the same filter active would look like <code>api.huntress.io/v1/agents?organization_id=1&page_token=MjAyMi0wMy0wMVQxODo1NDoyNFo</code>.</p>\n\t</details>\n\t<details>\n\t\t<summary><h3 id='response'>Response</h3></summary>\n\t<p>The Huntress API responds with a JSON object containing requested resources if the request is valid and authorized.</p>\n\t<h4 id='singular-case'>Singular Case</h4>\n\t<div class=\"scalar-code-copy\">\n\t<pre class=\"scalar-codeblock-pre\"><code class=\"hljs-json\"><span class=\"hljs-punctuation\">{</span>\n<span class=\"hljs-attr\"> \"report\"</span><span class=\"hljs-punctuation\">: { ... }\n}</span></code>\n</div>\n\t<p>In the case of accessing a singular resource, the JSON object in question will contain one key that maps the singular resource to the singular representation of the resource name. As an example, if you were to request <code>api.huntress.io/v1/reports/1</code>, the JSON response would contain a single key <code>report</code> that maps to the report with ID: 1.</p>\n\t<h4 id='multiple-case'>Multiple Case</h4><div class=\"highlight\"><pre class=\"highlight json tab-json\">\n<pre class=\"scalar-codeblock-pre\"><code class=\"hljs-json\"><span class=\"hljs-punctuation\">{</span>\n<span class=\"hljs-attr\"> \"reports\"</span><span class=\"hljs-punctuation\">: [ ... ],</span>\n<span class=\"hljs-attr\"> \"pagination\"</span><span class=\"hljs-punctuation\">: { ... }</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre></div>\n\t<p>When accessing a list of resources, the JSON response contains two keys at the root level. The first key is the plural representation of that resource. The second is a <code>pagination</code> key that represents the current state of pagination based on parameters provided in the original request. As an example, a request to <code>api.huntress.io/v1/reports</code> returns a JSON object with the keys <code>reports</code> and <code>pagination</code> at its root level. Further details on the fields within the pagination object can be seen at <a href=\"#pagination\">the relevant section</a>.</p>\n\t</details>\n</details>\n"
version: 1.0.0
host: api.huntress.io
schemes:
- https
produces:
- application/json
security:
- basic:
- basic_auth
tags:
- name: Unwanted Access Rules
description: Operations about Unwanted Access Rules
paths:
/v1/unwanted_access_rules:
get:
summary: List Unwanted Access Rules
description: 'Shows Unwanted Access Rules associated with your account.
Unwanted Access Rules govern how Huntress responds to identity access attempts matching specific attributes. Each rule targets a category (country, vpn, ip_address) and declares a determination — `expected` or `unauthorized` — at the account, organization, or identity scope.
**Note:** This endpoint will also return a `pagination` key on the root level.
Please refer to the [pagination section](https://api.huntress.io/docs#pagination) within our docs for more information.
'
produces:
- application/json
parameters:
- in: query
name: limit
description: Max number of resources returned in a paged collection. Defaults to 10, with a minimum of 1 and maximum 500.
type: integer
format: int32
default: 10
minimum: 1
maximum: 500
required: false
- in: query
name: page_token
description: Token used to request the next page in paginated results. Defaults to 'null'
type: string
required: false
- in: query
name: organization_id
description: Filter by organization ID within Huntress account.
type: integer
format: int32
required: false
- in: query
name: identity_id
description: Filter results to rules attached directly to this identity.
type: integer
format: int32
required: false
- in: query
name: type
description: Filter by rule type.
type: string
enum:
- expected
- unauthorized
required: false
- in: query
name: status
description: Filter by rule status as shown in the Portal UI.
type: string
enum:
- active
- scheduled
- expired
required: false
- in: query
name: scope
description: Filter by the level the rule is attached to.
type: string
enum:
- account
- organization
- identity
required: false
- in: query
name: category
description: Limit results to a single rule category.
type: string
enum:
- country
- vpn
- ip_address
required: false
- in: query
name: country_code
description: Filter by country code value (ISO 3166-1 alpha-2). Implies `category=country`.
type: string
required: false
- in: query
name: vpn
description: Filter by VPN (tunnel operator) value. Implies `category=vpn`.
type: string
required: false
- in: query
name: ip_address
description: Filter by IP Address value. Implies `category=ip_address`.
type: string
required: false
- in: query
name: logic
description: 'Filter by rule logic. `standard` returns rules with explicit values,
`catchall` returns rules matching all values in a category,
and `catchall_exception` returns rules that exclude specifically set values from an existing catchall rule.
Omit this parameter to include all three.
'
type: string
enum:
- standard
- catchall
- catchall_exception
required: false
responses:
'200':
description: List Unwanted Access Rules
schema:
type: object
properties:
unwanted_access_rules:
type: array
items:
$ref: '#/definitions/UnwantedAccessRule'
pagination:
$ref: '#/definitions/Pagination'
required:
- unwanted_access_rules
- pagination
'400':
description: Invalid request parameters.
schema:
$ref: '#/definitions/UnwantedAccessRule'
'403':
description: There was an issue with your API credential or permissions.
schema:
$ref: '#/definitions/UnwantedAccessRule'
tags:
- Unwanted Access Rules
operationId: getV1UnwantedAccessRules
post:
summary: Create an Unwanted Access Rule
description: "Creates a new Unwanted Access Rule associated with your account, an organization, or a specific identity.\n\n**Rule logic.** Provide exactly one of `country_code`, `vpn`, or `logic`:\n - Omit `logic` and supply `country_code` or `vpn` to create `standard` rules. Provide a single value to create one rule, or a comma-separated list to create one `standard` rule per value in a single request. All rules share the same scope, type, and schedule, and are created atomically. If any value fails validation (for example a duplicate rule already exists), no rules are created. Duplicate values in the list are ignored. Only the last created rule is returned in the response.\n - Set `logic` as `catchall` (with `category`) to create a catchall rule that matches every value in the category. Catchalls must be `unauthorized` and may only be scoped to the account or an organization. An account or organization may have at most one catchall per category.\n - Set `logic` as `catchall_exception` (with `category`) to create an exception that opts an organization out of an account-level catchall. Exceptions must be `expected`, may only be scoped to an organization, and must omit `starts_at`/`expires_at`.\n\n**Scope.** The rule scope is determined by the IDs supplied: provide `identity_id` to scope the rule to a single identity, `organization_id` to scope it to an organization. Omitting both scopes the rule at the account level.\n"
produces:
- application/json
consumes:
- application/json
parameters:
- name: UnwantedAccessRuleCreationParameters
in: body
required: true
schema:
$ref: '#/definitions/UnwantedAccessRuleCreationParameters'
responses:
'201':
description: Create an Unwanted Access Rule
schema:
type: object
properties:
unwanted_access_rule:
$ref: '#/definitions/UnwantedAccessRule'
'400':
description: Invalid request parameters.
'403':
description: There was an issue with your API credential or permissions.
'404':
description: Specified organization or identity not found.
'422':
description: Invalid creation parameters. The rule failed validation — for example, a duplicate rule already exists, the scope is not allowed for the chosen logic, or the type/schedule fields conflict with the rule logic.
tags:
- Unwanted Access Rules
operationId: UnwantedAccessRuleCreationParameters
/v1/unwanted_access_rules/{id}:
get:
summary: Get Unwanted Access Rule
description: Shows details on a single Unwanted Access Rule associated with your account.
produces:
- application/json
parameters:
- in: path
name: id
description: Unwanted Access Rule ID.
type: integer
format: int32
required: true
responses:
'200':
description: Get Unwanted Access Rule
schema:
type: object
properties:
unwanted_access_rule:
$ref: '#/definitions/UnwantedAccessRule'
'403':
description: There was an issue with your API credential or permissions.
schema:
$ref: '#/definitions/UnwantedAccessRule'
'404':
description: Unwanted Access Rule not found.
schema:
$ref: '#/definitions/UnwantedAccessRule'
tags:
- Unwanted Access Rules
operationId: getV1UnwantedAccessRulesId
delete:
summary: Delete Unwanted Access Rule
description: 'Deletes a single Unwanted Access Rule associated with your account. Standard, catchall, and catchall exception rules can all be deleted through this endpoint.
'
produces:
- application/json
parameters:
- in: path
name: id
description: Unwanted Access Rule ID.
type: integer
format: int32
required: true
responses:
'202':
description: Unwanted Access Rule deleted
schema:
type: object
properties:
unwanted_access_rule:
$ref: '#/definitions/UnwantedAccessRule'
'403':
description: There was an issue with your API credential or permissions.
'404':
description: Unwanted Access Rule not found or has already been deleted
'422':
description: Failed to delete unwanted access rule. Please contact support.
tags:
- Unwanted Access Rules
operationId: deleteV1UnwantedAccessRulesId
patch:
summary: Update an Unwanted Access Rule
description: 'Updates the schedule and notes on an existing Unwanted Access Rule. The rule''s category, value, scope, logic, and type cannot be changed.
Standard, catchall, and catchall exception rules can all be updated, but catchall and catchall exception rules must keep `starts_at` and `expires_at` nil. Passing a value for those fields on those rules will return a 422.
'
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
description: Unwanted Access Rule ID.
type: integer
format: int32
required: true
- name: UnwantedAccessRuleUpdateParameters
in: body
required: true
schema:
$ref: '#/definitions/UnwantedAccessRuleUpdateParameters'
responses:
'200':
description: Update an Unwanted Access Rule
schema:
type: object
properties:
unwanted_access_rule:
$ref: '#/definitions/UnwantedAccessRule'
'400':
description: Invalid request parameters.
'403':
description: There was an issue with your API credential or permissions.
'404':
description: Unwanted Access Rule not found.
'422':
description: Invalid update parameters.
tags:
- Unwanted Access Rules
operationId: UnwantedAccessRuleUpdateParameters
definitions:
Pagination:
type: object
properties:
next_page_url:
type: string
next_page_token:
type: string
description: Pagination model
UnwantedAccessRuleCreationParameters:
type: object
properties:
identity_id:
type: integer
format: int32
description: Scope the rule to a specific identity. Mutually exclusive with `organization_id`. If neither is provided, the rule is scoped to the account.
organization_id:
type: integer
format: int32
description: Scope the rule to an organization. Mutually exclusive with `identity_id`. If neither is provided, the rule is scoped to the account.
country_code:
type: string
description: ISO 3166-1 alpha-2 country code(s) this rule should match. Provide for `standard` rules. Accepts a single code or a comma-separated list, which creates one rule per code. Mutually exclusive with `vpn` and `logic`.
vpn:
type: string
description: Tunnel operator name(s) this rule should match. Provide for `standard` rules. Accepts a single name or a comma-separated list, which creates one rule per name. Mutually exclusive with `country_code` and `logic`.
logic:
type: string
description: Rule logic. Set to `catchall` to match every value in a category, or `catchall_exception` to opt an organization out of an account-level catchall. Omit to create a `standard` rule (in which case `country_code` or `vpn` is required). Mutually exclusive with `country_code` and `vpn`.
enum:
- catchall
- catchall_exception
type:
type: string
description: Whether matching access is `expected` or `unauthorized`. Must be `unauthorized` when rule `logic` is `catchall` and `expected` when rule `logic` is `catchall_exception`.
enum:
- expected
- unauthorized
starts_at:
type: string
format: date
description: UTC date (YYYY-MM-DD) when the rule becomes active. Omit for `expected` rules that should start immediately. Must be omitted for `unauthorized` rules and for rules with `logic` of `catchall` or `catchall_exception`.
expires_at:
type: string
format: date
description: UTC date (YYYY-MM-DD) when the rule expires. Omit for `expected` rules that should never expire. Must be omitted for `unauthorized` rules and for rules with `logic` of `catchall` or `catchall_exception`.
notes:
type: string
description: Optional free-text note to attach to the rule.
category:
type: string
description: Category that the catchall or exception applies to. Required when `logic` is provided.
enum:
- country
- vpn
required:
- type
description: Create an Unwanted Access Rule
UnwantedAccessRuleUpdateParameters:
type: object
properties:
starts_at:
type: string
format: date
description: UTC date (YYYY-MM-DD) when the rule becomes active. Pass an empty string or null to clear.
expires_at:
type: string
format: date
description: UTC date (YYYY-MM-DD) when the rule expires. Pass an empty string or null to clear.
notes:
type: string
description: Free-text note attached to the rule. Pass an empty string or null to clear.
description: Update an Unwanted Access Rule
UnwantedAccessRule:
type: object
properties:
id:
type: integer
format: int64
example: 84938
description: A Huntress-unique identifier for the rule.
applied_to:
type: Object
example:
type: Organization
id: 1234
name: ExampleCo
description: The resource this rule applies to.
category:
type: string
enum:
- country
- vpn
- ip_address
example: country
description: The category of attribute this rule governs.
country_code:
type: string
example: US
description: ISO 3166-1 alpha-2 country code this rule matches. Null unless `category` is `country`.
vpn:
type: string
example: NORD_VPN
description: Tunnel operator name this rule matches. Null unless `category` is `vpn`.
ip_address:
type: string
example: 203.0.113.0/24
description: IP Address this rule matches. Null unless `category` is `ip_address`.
type:
type: string
enum:
- expected
- unauthorized
example: unauthorized
description: Whether matching access is expected or unauthorized.
status:
type: string
enum:
- active
- scheduled
- expired
- not_applicable
example: active
description: The current status of the rule.
logic:
type: string
enum:
- catchall_exception
- catchall
- standard
example: standard
description: 'How the rule matches: `standard` matches a specific value within the `country`, `vpn`, or `ip_address` category, `catchall` matches all values in the category, and `catchall_exception` opts the resource out of an inherited catchall.'
note:
type: string
example: Approved by compliance — regional office access
description: Optional free-text note the rule author attached to the rule.
starts_at:
type: string
format: date-time
example: '2025-09-05T18:20:34Z'
description: ISO-8601 formatted timestamp for when this rule becomes active. Null for unscheduled rules.
expires_at:
type: string
format: date-time
example: '2025-12-05T18:20:34Z'
description: ISO-8601 formatted timestamp for when this rule expires. Null if the rule does not expire.
created_by:
type: string
example: Jane Doe
description: The name of the user who created this rule, or "Deleted" if the user has been removed.
created_at:
type: string
format: date-time
example: '2025-09-05T18:20:34Z'
description: ISO-8601 formatted timestamp for when this rule was created.
updated_at:
type: string
format: date-time
example: '2025-09-05T18:20:34Z'
description: ISO-8601 formatted timestamp for when this rule was last updated.
description: UnwantedAccessRule model
securityDefinitions:
basic_auth:
type: basic
desc: Base 64 encoded string of your Huntress Account API key and API secret.