APIClarity

APIClarity Local Bfla API

The local-bfla API from APIClarity — 10 operation(s) for local-bfla.

GitHub OpenAPI

Operations 10

GET /version Get the version of this Module #
PUT /authorizationModel/{apiID}/approve Replace authorization model by api id approve #
PUT /authorizationModel/{apiID}/deny Replace authorization model by api id deny #
GET /event/{id} Get the event with the annotations and bfla status #
PUT /event/{id}/{operation} Replace event by id by operation #
PUT /modules/bfla/authorizationModel/{apiID}/approve Replace modules bfla authorization model by api id approve #
PUT /modules/bfla/authorizationModel/{apiID}/deny Replace modules bfla authorization model by api id deny #
GET /modules/bfla/event/{id} Get the event with the annotations and bfla status #
PUT /modules/bfla/event/{id}/{operation} Replace modules bfla event by id by operation #
GET /modules/bfla/version Get the version of this Module #

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-local-bfla-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-local-bfla-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-local-bfla-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Apiclarity Local Bfla API
  version: '1.0'
  description: 'Operations tagged local-bfla across 2 of this provider''s published API definitions: apiclarity-bfla-module-openapi.yml, apiclarity-global-openapi.gen.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
tags:
- name: local-bfla
paths:
  /version:
    get:
      operationId: getVersion
      summary: Get the version of this Module
      tags:
      - local-bfla
      responses:
        '200':
          description: Version of the Module
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ModuleVersion
  /authorizationModel/{apiID}/approve:
    put:
      tags:
      - local-bfla
      parameters:
      - name: apiID
        in: path
        required: true
        schema:
          $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiID
      - in: query
        name: method
        required: true
        schema:
          type: string
      - in: query
        name: path
        required: true
        schema:
          type: string
      - in: query
        name: k8sClientUid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
      summary: Replace authorization model by api id approve
      x-summary-source: derived
      operationId: putAuthorizationModelByApiIDApprove
      x-operation-id-source: derived
  /authorizationModel/{apiID}/deny:
    put:
      tags:
      - local-bfla
      parameters:
      - name: apiID
        in: path
        required: true
        schema:
          $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiID
      - in: query
        name: method
        required: true
        schema:
          type: string
      - in: query
        name: path
        required: true
        schema:
          type: string
      - in: query
        name: k8sClientUid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
      summary: Replace authorization model by api id deny
      x-summary-source: derived
      operationId: putAuthorizationModelByApiIDDeny
      x-operation-id-source: derived
  /event/{id}:
    get:
      tags:
      - local-bfla
      operationId: get_event
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      summary: Get the event with the annotations and bfla status
      responses:
        '200':
          description: API Event with annotations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEventAnnotations'
  /event/{id}/{operation}:
    put:
      tags:
      - local-bfla
      parameters:
      - in: path
        schema:
          type: integer
        required: true
        name: id
      - in: path
        required: true
        name: operation
        schema:
          $ref: '#/components/schemas/OperationEnum'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
        default:
          description: Error response
          content:
            application/json:
              schema:
                $ref: ../../../../../../api3/common/openapi.yaml#/components/schemas/ApiResponse
      summary: Replace event by id by operation
      x-summary-source: derived
      operationId: putEventByIdByOperation
      x-operation-id-source: derived
  /modules/bfla/authorizationModel/{apiID}/approve:
    put:
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      - in: query
        name: method
        required: true
        schema:
          type: string
      - in: query
        name: path
        required: true
        schema:
          type: string
      - in: query
        name: k8sClientUid
        required: true
        schema:
          type: string
      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
      tags:
      - local-bfla
      summary: Replace modules bfla authorization model by api id approve
      x-summary-source: derived
      operationId: putModulesBflaAuthorizationModelByApiIDApprove
      x-operation-id-source: derived
    servers:
    - url: /api
  /modules/bfla/authorizationModel/{apiID}/deny:
    put:
      parameters:
      - in: path
        name: apiID
        required: true
        schema:
          $ref: ../common/openapi.yaml#/components/schemas/ApiID
      - in: query
        name: method
        required: true
        schema:
          type: string
      - in: query
        name: path
        required: true
        schema:
          type: string
      - in: query
        name: k8sClientUid
        required: true
        schema:
          type: string
      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
      tags:
      - local-bfla
      summary: Replace modules bfla authorization model by api id deny
      x-summary-source: derived
      operationId: putModulesBflaAuthorizationModelByApiIDDeny
      x-operation-id-source: derived
    servers:
    - url: /api
  /modules/bfla/event/{id}:
    get:
      operationId: bflaget_event
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEventAnnotations'
          description: API Event with annotations
      summary: Get the event with the annotations and bfla status
      tags:
      - local-bfla
    servers:
    - url: /api
  /modules/bfla/event/{id}/{operation}:
    put:
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: integer
      - in: path
        name: operation
        required: true
        schema:
          $ref: '#/components/schemas/OperationEnum'
      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
      tags:
      - local-bfla
      summary: Replace modules bfla event by id by operation
      x-summary-source: derived
      operationId: putModulesBflaEventByIdByOperation
      x-operation-id-source: derived
    servers:
    - url: /api
  /modules/bfla/version:
    get:
      operationId: bflagetVersion
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ModuleVersion
          description: Version of the Module
      summary: Get the version of this Module
      tags:
      - local-bfla
    servers:
    - url: /api
components:
  schemas:
    DetectedUser:
      required:
      - id
      - source
      - ip_address
      properties:
        id:
          type: string
        source:
          type: string
          enum:
          - JWT
          - BASIC
          - KONG_X_CONSUMER_ID
        ip_address:
          type: string
    APIEventAnnotations:
      required:
      - bflaStatus
      - external
      - mismatchedScopes
      properties:
        external:
          type: boolean
        mismatchedScopes:
          type: boolean
        destinationK8sObject:
          $ref: '#/components/schemas/K8sObjectRef'
        sourceK8sObject:
          $ref: '#/components/schemas/K8sObjectRef'
        bflaStatus:
          $ref: '#/components/schemas/BFLAStatus'
        detectedUser:
          $ref: '#/components/schemas/DetectedUser'
    K8sObjectRef:
      type: object
      required:
      - uid
      - kind
      - name
      - namespace
      - apiVersion
      properties:
        uid:
          type: string
        kind:
          type: string
        name:
          type: string
        namespace:
          type: string
        apiVersion:
          type: string
    OperationEnum:
      type: string
      enum:
      - approve
      - deny
      - approve_user
      - deny_user
    BFLAStatus:
      type: string
      enum:
      - NO_SPEC
      - LEARNING
      - LEGITIMATE
      - SUSPICIOUS_MEDIUM
      - SUSPICIOUS_HIGH
x-refined-from:
- apiclarity-bfla-module-openapi.yml
- apiclarity-global-openapi.gen.yml