APIClarity

APIClarity Control API

Control-plane endpoints for trace sources and discovered APIs.

GitHub OpenAPI

Operations 5

POST /control/newDiscoveredAPIs Allows a client to notify APIClarity about new APIs.
GET /control/traceSources List of configured trace sources
POST /control/traceSources Create a new Trace Source
GET /control/traceSources/{traceSourceId} Get Trace Source information
DELETE /control/traceSources/{traceSourceId} Delete a Trace Source

Documentation

📖
Documentation
https://github.com/openclarity/apiclarity#readme
📖
GettingStarted
https://github.com/openclarity/apiclarity#getting-started

Specifications

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

SDKs

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/overlays/apiclarity-control-api-overlay.yaml

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-control-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-control-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIClarity API Events Control API
  description: APIClarity is an open source API security and observability tool that analyzes API traffic to reconstruct OpenAPI specifications, detect shadow and zombie APIs, identify API differences and changes, and provide API security alerts. This is the REST API exposed by an APIClarity deployment.
  version: 1.0.0
  contact:
    name: OpenClarity
    url: https://github.com/openclarity/apiclarity
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080/api
  description: Local APIClarity deployment
tags:
- name: Control
  description: Control-plane endpoints for trace sources and discovered APIs.
paths:
  /control/newDiscoveredAPIs:
    post:
      summary: Allows a client to notify APIClarity about new APIs.
      description: This allows a client (a gateway for example) to notify APIclarity about newly discovered APIs. If one of the APIs already exists, it is ignored.
      tags:
      - Control
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - hosts
              properties:
                hosts:
                  type: array
                  description: List of discovered APIs, format of hostname:port
                  items:
                    type: string
        description: List of new discovered APIs
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        default:
          description: Response
  /control/traceSources:
    get:
      summary: List of configured trace sources
      tags:
      - Control
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                required:
                - trace_sources
                properties:
                  trace_sources:
                    type: array
                    description: List of trace sources
                    items:
                      $ref: '#/components/schemas/TraceSource'
        default:
          description: Response
    post:
      summary: Create a new Trace Source
      tags:
      - Control
      requestBody:
        required: true
        content:
          application/json:
            schema:
              description: Create a new Trace Source
              $ref: '#/components/schemas/TraceSource'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceSource'
        default:
          description: Response
  /control/traceSources/{traceSourceId}:
    get:
      summary: Get Trace Source information
      tags:
      - Control
      parameters:
      - $ref: '#/components/parameters/traceSourceId'
      responses:
        '200':
          description: Trace Source information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceSource'
        '404':
          description: Trace Source not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        default:
          description: Response
    delete:
      summary: Delete a Trace Source
      tags:
      - Control
      parameters:
      - $ref: '#/components/parameters/traceSourceId'
      responses:
        '204':
          description: Success
        '404':
          description: Trace Source not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        default:
          description: Response
components:
  parameters:
    traceSourceId:
      name: traceSourceId
      in: path
      required: true
      description: Trace Source ID
      schema:
        type: string
        format: uuid
  schemas:
    ApiResponse:
      description: An object that is return in all cases of failures.
      type: object
      properties:
        message:
          type: string
    SuccessResponse:
      type: object
      description: 'An object that is return in cases of success that return nothing.'
      properties:
        message:
          type: string
    TraceSource:
      description: A Source which is sending traces to APIClarity
      type: object
      properties:
        id:
          type: integer
        uid:
          type: string
          format: uuid
        name:
          description: Unique name identifying a Trace Source
          type: string
        type:
          $ref: '#/components/schemas/TraceSourceType'
        description:
          type: string
        token:
          type: string
      required:
      - name
      - type
    TraceSourceType:
      type: string
      enum:
      - APIGEE_X
      - F5_BIG_IP
      - KONG_INTERNAL
      - TYK_INTERNAL