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

Create, validate, and run detection rules (Sigma / scheduled SQL).

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

10 operations 6 paths 0 schemas 1 DELETE4 GET1 PATCH4 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 Rules 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 10

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

Rules 10

Create, validate, and run detection rules (Sigma / scheduled SQL).

POST
/public/v1/rules/validate
Validate rule content (Sigma YAML or SQL) without persisting a rule.
validate_rule_public_api → 200401403404422429
POST
/public/v1/rules
Create a rule in your organization (sigma, scheduledsql, signalcombination).
create_rule_public_api → 200401403404422429
GET
/public/v1/rules
List rules for the authenticated organization.
list_rules_public_api → 200401403404422429
GET
/public/v1/rules/{rule_id}
Get a rule by ID (latest version unless a version is given).
get_rule_public_api 1 param → 200401403404422429
DELETE
/public/v1/rules/{rule_id}
Delete a rule (all versions) in your organization.
delete_rule_public_api 1 param → 200401403404422429
PATCH
/public/v1/rules/{rule_id}
Update a rule in your organization.
update_rule_public_api 1 param → 200401403404422429
POST
/public/v1/rules/{rule_id}/test_sql_rule
Run an on-demand test execution for a scheduledsql rule.
test_sql_rule_public_api 1 param → 200401403404422429
POST
/public/v1/rules/{rule_id}/runs
Trigger a retroactive run of a scheduledsql rule.
run_rule_scheduled_sase_public_api 1 param → 200401403404422429
GET
/public/v1/rules/{rule_id}/runs
List scheduled-sase runs for a scheduledsql rule (metadata only).
get_rule_runs_scheduled_sase_public_api 1 param → 200401403404422429
GET
/public/v1/rules/{rule_id}/runs/{rule_run_id}
Get row-level results for a single scheduled-sase run.
get_rule_run_results_scheduled_sase_public_api 2 params → 200401403404422429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nebulock-rules-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 Hunts API
AE Profile APIs.io
#Rules
← Back to N APIs
API Details
ID
nebulock:nebulock-rules-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