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

APIClarity Fuzzer Module API

Active security testing. Drives generated traffic at an API based on its specification to find implementation flaws, then returns a severity-ranked report and a specification annotated with the findings. Served under /api/modules/fuzzer.

APIClarity Fuzzer Module API is one of 11 APIs that APIClarity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fuzzing, Security Testing, and API Security. The published artifact set on APIs.io includes an OpenAPI specification and a GitHub repository.

This API exposes 13 operations across 12 paths, organized into 3 resource areas, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version 0.0.1.

Requests are made against a single base URL, /.

13 operations 12 paths 32 schemas 10 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.1
Base URL
https://apiclarity-server/api/modules/fuzzer
Resource Areas
3

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 10 GET, 3 POST. They span 3 resource areas: Operations, fuzzer, local-fuzzer. Each is listed below with its method, path, parameters, and response codes.

Operations 3
GET
/version
Get the version of this Module
getVersion → 200
GET
/state
Get the current running state of this module
getState → 200
GET
/apiFindings/{apiID}
Get findings for an API and module
GetAPIFindings 2 params → 200default
fuzzer 4

Everything about Fuzzer

POST
/fuzz/{apiID}/start
Start a test for an API
StartTest 1 param body → 200400404500
POST
/fuzz/{apiID}/stop
Stop (cancel) a running test for an API
StopTest 1 param → 204404400500
GET
/fuzz/{apiID}/progress
Start a test for an API
GetTestProgress 1 param → 200404500
GET
/fuzz/{apiID}/report
Start a test for an API
GetTestReport 1 param → 200404500
local-fuzzer 6

Methods used by APIClarity UI

GET
/updateStatus/{apiID}
Retreive last update status for an API under fuzzing
GetUpdateStatus 1 param → 200
POST
/updateStatus/{apiID}
Update status for an API under fuzzing
PostUpdateStatus 1 param body → 204
GET
/tests/{apiID}
Retreieve the list of tests for an API
GetTests 1 param → 200
GET
/report/{apiID}/{timestamp}
Retreive a report for an API
GetReport 2 params → 200
GET
/report/{apiID}/{timestamp}/short
Retrieve a report for an API for a specific test
GetShortReportByTimestamp 2 params → 200
GET
/annotatedspec/{apiID}
Retreive the annotated spec for an API
GetAnnotatedSpec 1 param → 200404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are FuzzingReportItem (7 properties), ShortTestReport (6 properties), RawFindings (6 properties), TestWithReport (6 properties). Each schema is shown below with its type and property counts.

TestHandle
object
2 properties
TestReportNotification
TestProgressNotification
AuthorizationTypeEnum
string
An enumeration for the authorization type parameter.
AuthorizationSchemeBase
object
1 property 1 required
BasicAuth
ApiToken
BearerToken
AuthorizationScheme
TestInputDepthEnum
string
An enumeration for input depth parameter.
TestInput
object
contains all input parameters for a test
2 properties 1 required
Version
object
1 property 1 required
TestingModuleState
object
2 properties 2 required
FuzzingStatusEnum
string
An enumeration.
RawFindingsSourceEnum
string
An enumeration.
ScoreExitStatusEnum
string
An enumeration.
FuzzingReportPath
object
Current fuzzer report
5 properties
FuzzingReportItem
object
Current fuzzer report
7 properties
FuzzingStatusAndReport
object
fuzzing status and reporting
3 properties 3 required
RawFindingsSeverity
object
1 property
RawFindings
object
6 properties
RawFindingsBundle
object
5 properties 4 required
Findings
object
2 properties
Finding
object
3 properties
Tests
object
2 properties
Vulnerabilities
object
risk of the finding
5 properties
Test
object
4 properties
TestWithReport
object
6 properties
ShortTestProgress
object
Describes the progress of an ongoing test
3 properties 2 required
ShortTestReport
object
Short Test Report
6 properties 2 required
FuzzingReportTag
object
Report tag item
3 properties 2 required
FuzzingReportOperation
object
Report tag operation
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-fuzzer-module-openapi.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity API Inventory API
APIClarity Control API
APIClarity Features API
APIClarity BFLA Module API
APIClarity Trace Analyzer Module API
APIClarity Spec Differ Module API
APIClarity Spec Reconstructor Module API
APIClarity Plugins Telemetry API
APIClarity Notifications API
Where this information came from

This is an independent, third-party profile of APIClarity Fuzzer Module 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.