How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Scanner Detection Rules API

Create, list, update, and delete streaming detection rules.

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

Tagged areas include Detection Rules. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://{environment}.scanner.dev.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://app.scanner.dev
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Scanner Detection Rules API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Scanner API key presented as Authorization: Bearer . Create keys in Settings API Keys.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Detection Rules 5

Create, list, update, and delete streaming detection rules.

POST
/v1/detection_rule
Create detection rule
createDetectionRule body → 200400
GET
/v1/detection_rule
List detection rules
listDetectionRules 3 params → 200400
GET
/v1/detection_rule/{id}
Get detection rule
getDetectionRule 1 param → 200404
PUT
/v1/detection_rule/{id}
Update detection rule
updateDetectionRule 1 param body → 200400404
DELETE
/v1/detection_rule/{id}
Delete detection rule
deleteDetectionRule 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DetectionRule (16 properties), DetectionRuleCreate (13 properties), DetectionRuleUpdate (12 properties), AlertTemplate (2 properties). Each schema is shown below with its type and property counts.

DeletedRef
object
2 properties
DetectionRule
object
16 properties
DetectionRuleCreate
object
13 properties 9 required
Pagination
object
1 property
AlertTemplate
object
2 properties
DetectionRuleUpdate
object
12 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

scanner-detection-rules-api-openapi.yml Raw ↑

Other APIs Scanner publishes across the network.

Scanner Ad Hoc Queries API
Scanner Event Sinks API
Scanner Indexes API
Scanner Info API
Scanner Lookup Tables API
Where this information came from

This is an independent, third-party profile of Scanner Detection Rules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.