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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Nebulock

Nebulock Hunts API

Threat hunts, hunt suggestions, and hunt reports.

Documentation Provider Profile APIs.io OpenAPI GitHub

Nebulock Hunts API is one of 4 APIs that Nebulock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 20 operations across 16 paths. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://api.nebulock.io.

20 operations 16 paths 0 schemas 11 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.nebulock.io
Authentication
API Key, API Key
Contact
Nebulock
Resource Areas
1

Authentication & Security 2

Nebulock Hunts API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key-ID (ApiKeyId). An API key is passed in the header as X-API-Key-Secret (ApiKeySecret). By default, every request must be authenticated.

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 11 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Hunts 20

Threat hunts, hunt suggestions, and hunt reports.

POST
/public/v1/hunt_suggestions
Generate hunt suggestions based on threat intelligence context.
generate_hunt_suggestions → 200401403404422429
GET
/public/v1/hunt_suggestions
Retrieve a paginated list of hunt suggestions.
list_hunt_suggestions → 200401403404422429
GET
/public/v1/hunt_suggestions/jobs/{job_id}
Retrieve hunt suggestions for a specific job.
get_hunt_suggestions_by_job 1 param → 200401403404422429
GET
/public/v1/hunt_suggestions/{hunt_suggestion_id}
Retrieve a single hunt suggestion by ID.
get_hunt_suggestion 1 param → 200401403404422429
GET
/public/v1/hunt_agent_versions
Return available agent versions, supported modes, defaults, and deprecation status.
get_hunt_agent_versions → 200401403404422429
GET
/public/v1/hunt_reports
Retrieve a paginated list of hunt reports.
list_hunt_reports → 200401403404422429
GET
/public/v1/hunt_reports/{hunt_report_id}
Retrieve a single hunt report with markdown content.
get_hunt_report 1 param → 200401403404422429
GET
/public/v1/hunt_reports/{hunt_report_id}/pdf
Download the hunt report as a PDF file.
get_hunt_report_pdf 1 param → 200401403404422429
POST
/public/v1/hunt_reports/{hunt_report_id}/retry
Retry generation of a failed hunt report.
retry_hunt_report 1 param → 200401403404422429
GET
/public/v2/hunts
Retrieve a paginated list of hunts (default source filter 'manual').
list_hunts_v2 → 200401403404422429
POST
/public/v2/hunts
Create a hunt with async directive processing.
create_hunt_v2 → 200401403404422429
GET
/public/v2/hunts/{hunt_id}
Get a hunt with directives, blocks, and user enrichment.
get_hunt_v2 1 param → 200401403404422429
PATCH
/public/v2/hunts/{hunt_id}
Update a hunt's properties.
update_hunt_v2 1 param → 200401403404422429
PATCH
/public/v2/hunts/{hunt_id}/generate_report
Trigger report generation for a hunt.
generate_hunt_report_v2 1 param → 200401403404422429
GET
/public/v2/hunts/{hunt_id}/directives/{directive_id}
Get a directive with blocks and user enrichment.
get_directive_v2 2 params → 200401403404422429
POST
/public/v2/hunts/{hunt_id}/directives
Add a new directive (follow-up query) to an existing hunt.
add_directive_v2 1 param → 200401403404422429
POST
/public/v2/hunts/{hunt_id}/directives/{directive_id}/retry
Retry a directive that has failed processing.
retry_directive_v2 2 params → 200401403404422429
POST
/public/v2/hunts/{hunt_id}/directives/{directive_id}/stop
Stop a directive that is currently being processed.
stop_directive_v2 2 params → 200401403404422429
GET
/public/v2/hunt_reports/{hunt_report_id}/feedback
List append-only feedback rows for a completed hunt report.
list_hunt_report_feedback_v2 1 param → 200401403404422429
POST
/public/v2/hunt_reports/{hunt_report_id}/feedback
Create append-only feedback for a completed hunt report.
create_hunt_report_feedback_v2 1 param → 200401403404422429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nebulock-hunts-api-openapi.yml Raw ↑

Other APIs Nebulock publishes across the network.

Nebulock Entities API
AE Profile APIs.io
Nebulock Findings API
AE Profile APIs.io
Nebulock Rules API
AE Profile APIs.io
#Hunts
← Back to N APIs
API Details
ID
nebulock:nebulock-hunts-api
Base URL
https://api.nebulock.io
Docs
https://docs.nebulock.io/reference/getting-started-with-the-nebulock-findings-api
Provider
Nebulock
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network