APIClarity

APIClarity Modules API

The Modules API from APIClarity — 14 operation(s) for modules.

GitHub OpenAPI

Operations 14

GET /modules/fuzzer/apiFindings/{apiID} Get findings for an API and module #
GET /modules/fuzzer/state Get the current running state of this module #
GET /modules/fuzzer/version Get the version of this Module #
POST /modules/spec_differ/{apiID}/start Start Differ for an API #
POST /modules/spec_differ/{apiID}/stop Stop Differ for an API #
POST /modules/specreconstructor/{apiID}/start Start the spec reconstruction for this API #
POST /modules/specreconstructor/{apiID}/stop Stop the spec reconstruction for this API #
POST /modules/specreconstructor/enable enable/disable the spec reconstruction #
GET /modules/specreconstructor/version Get the version of this Plugin #
POST /modules/traceanalyzer/{apiID}/start Start Trace Analysis for an API #
POST /modules/traceanalyzer/{apiID}/stop Stop Trace Analysis for an API #
GET /modules/traceanalyzer/apiFindings/{apiID} Get findings for an API and module #
POST /modules/traceanalyzer/apiFindings/{apiID}/reset Delete all API findings for an API #
GET /modules/traceanalyzer/eventAnnotations/{eventID} Get Annotations for an event #

Documentation

📖
Documentation
https://github.com/openclarity/apiclarity#readme
📖
GettingStarted
https://github.com/openclarity/apiclarity#getting-started
📖
Documentation
https://github.com/openclarity/apiclarity/blob/master/backend/pkg/modules/internal/bfla/README.md
📖
Documentation
https://github.com/openclarity/apiclarity/blob/master/backend/pkg/modules/internal/traceanalyzer/README.md
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/authentication/apiclarity-authentication.yml
📖
Documentation
https://github.com/openclarity/apiclarity/tree/master/plugins
📖
Documentation
https://github.com/openclarity/apiclarity/tree/master/api3#apiclarity-notification-specification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/openapi/apiclarity-modules-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/openclarity/apiclarity

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/asyncapi/apiclarity-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apiclarity-modules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apiclarity-modules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIClarity Modules API
  version: 1.0.0
servers:
- url: /api
tags:
- name: Modules
paths:
  /modules/fuzzer/apiFindings/{apiID}:
    get:
      description: Asks for findings of an APIClarity module, and API. Implemented by each module
      operationId: fuzzerGetAPIFindings
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      - $ref: ../common/openapi.yaml#/components/parameters/Sensitive
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/APIFindings
          description: An API Findings Bundle
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Get findings for an API and module
      tags:
      - Modules
  /modules/fuzzer/state:
    get:
      description: Get useful informations about the current running state of the testing module
      operationId: fuzzergetState
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestingModuleState'
          description: Current testing module running state
      summary: Get the current running state of this module
      tags:
      - Modules
  /modules/fuzzer/version:
    get:
      operationId: fuzzergetVersion
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
          description: Version of the Module
      summary: Get the version of this Module
      tags:
      - Modules
  /modules/spec_differ/{apiID}/start:
    post:
      description: Start Differ for an API.
      operationId: spec_differStartDiffer
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Start Differ for an API
      tags:
      - Modules
  /modules/spec_differ/{apiID}/stop:
    post:
      description: Stop Differ for an API.
      operationId: spec_differStopDiffer
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Stop Differ for an API
      tags:
      - Modules
  /modules/specreconstructor/{apiID}/start:
    post:
      operationId: specreconstructorPostAPIIDStart
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '204':
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Start the spec reconstruction for this API
      tags:
      - Modules
  /modules/specreconstructor/{apiID}/stop:
    post:
      operationId: specreconstructorPostAPIIDStop
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '204':
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Stop the spec reconstruction for this API
      tags:
      - Modules
  /modules/specreconstructor/enable:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureEnable'
      responses:
        '204':
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: enable/disable the spec reconstruction
      tags:
      - Modules
      operationId: postModulesSpecreconstructorEnable
      x-operation-id-source: derived
  /modules/specreconstructor/version:
    get:
      operationId: specreconstructorgetVersion
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ModuleVersion
          description: Version of the Plugin
      summary: Get the version of this Plugin
      tags:
      - Modules
  /modules/traceanalyzer/{apiID}/start:
    post:
      description: Start Trace Analysis for an API.
      operationId: traceanalyzerStartTraceAnalysis
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Start Trace Analysis for an API
      tags:
      - Modules
  /modules/traceanalyzer/{apiID}/stop:
    post:
      description: Stop Trace Analysis for an API.
      operationId: traceanalyzerStopTraceAnalysis
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Stop Trace Analysis for an API
      tags:
      - Modules
  /modules/traceanalyzer/apiFindings/{apiID}:
    get:
      description: Asks for findings of an APIClarity module, and API. Implemented by each module
      operationId: traceanalyzerGetApiFindings
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      - $ref: ../common/openapi.yaml#/components/parameters/Sensitive
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/APIFindings
          description: An API Findings Bundle
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Get findings for an API and module
      tags:
      - Modules
  /modules/traceanalyzer/apiFindings/{apiID}/reset:
    post:
      operationId: traceanalyzerResetApiFindings
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      responses:
        '204':
          description: Reset
        default:
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Error response
      summary: Delete all API findings for an API
      tags:
      - Modules
  /modules/traceanalyzer/eventAnnotations/{eventID}:
    get:
      description: Get Trace Analyzer Annotations for a specific event
      operationId: traceanalyzerGetEventAnnotations
      parameters:
      - in: path
        name: eventID
        required: true
        schema:
          format: int64
          type: integer
      - $ref: '#/components/parameters/redacted'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotations'
          description: Annotation
      summary: Get Annotations for an event
      tags:
      - Modules
components:
  schemas:
    TestingModuleState:
      properties:
        APIsInCache:
          type: integer
        version:
          type: string
      required:
      - version
      - APIsInCache
      type: object
    Annotations:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Annotation'
          type: array
        total:
          description: Total event annotations count
          type: integer
      required:
      - total
      type: object
    FeatureEnable:
      description: Enable/disable a feature
      properties:
        enable:
          description: enable flag
          type: boolean
      type: object
    Annotation:
      properties:
        annotation:
          type: string
        kind:
          type: string
        name:
          type: string
        severity:
          type: string
      required:
      - id
      - name
      - annotation
      - severity
      - kind
      type: object
    Version:
      properties:
        version:
          type: string
      required:
      - version
      type: object
  parameters:
    redacted:
      in: query
      name: redacted
      schema:
        default: false
        type: boolean