APIClarity

APIClarity Control API

Control-plane endpoints for trace sources and discovered APIs.

Documentation 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 #

DELETE /control/traceSources/{traceSourceId} Delete a Trace Source #

GET /control/traceSources/{traceSourceId} Get Trace Source information #

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

openapi: 3.2.0
info:
  title: Apiclarity Control API
  version: 1.0.0
  description: 'Operations tagged Control across 2 of this provider''s published API definitions: apiclarity-global-openapi.gen.yml, apiclarity-plugins-telemetry-swagger.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api
tags:
- name: Control
paths:
  /control/newDiscoveredAPIs:
    post:
      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.
      requestBody:
        content:
          application/json:
            schema:
              properties:
                hosts:
                  description: List of discovered APIs, format of hostname:port
                  items:
                    type: string
                  type: array
              required:
              - hosts
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/SuccessResponse
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Allows a client to notify APIClarity about new APIs
      tags:
      - Control
      operationId: postControlNewDiscoveredAPIs
      x-operation-id-source: derived
    servers:
    - url: /api
  /control/traceSources:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  trace_sources:
                    description: List of trace sources
                    items:
                      $ref: '#/components/schemas/TraceSource'
                    type: array
                required:
                - trace_sources
                type: object
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: List of configured trace sources
      tags:
      - Control
      operationId: getControlTraceSources
      x-operation-id-source: derived
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TraceSource'
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceSource'
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Create a new Trace Source
      tags:
      - Control
      operationId: postControlTraceSources
      x-operation-id-source: derived
    servers:
    - url: /api
  /control/traceSources/{traceSourceId}:
    parameters:
    - $ref: '#/components/parameters/traceSourceId'
    delete:
      responses:
        '204':
          description: Success
        '404':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Trace Source not found
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Delete a Trace Source
      tags:
      - Control
      operationId: deleteControlTraceSourcesByTraceSourceId
      x-operation-id-source: derived
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TraceSource'
          description: Trace Source information
        '404':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: Trace Source not found
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get Trace Source information
      tags:
      - Control
      operationId: getControlTraceSourcesByTraceSourceId
      x-operation-id-source: derived
    servers:
    - url: /api
components:
  schemas:
    TraceSourceType:
      enum:
      - APIGEE_X
      - F5_BIG_IP
      - KONG_INTERNAL
      - TYK_INTERNAL
      type: string
    TraceSource:
      description: A Source which is sending traces to APIClarity
      properties:
        description:
          type: string
        id:
          type: integer
        name:
          description: Unique name identifying a Trace Source
          type: string
        token:
          type: string
        type:
          $ref: '#/components/schemas/TraceSourceType'
        uid:
          format: uuid
          type: string
      required:
      - name
      - type
      type: object
    SuccessResponse:
      description: An object that is return in cases of success that return nothing.
      type: object
      properties:
        message:
          type: string
    ApiResponse:
      description: An object that is return in all cases of failures.
      type: object
      properties:
        message:
          type: string
  responses:
    UnknownError:
      content:
        application/json:
          schema:
            $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
      description: unknown error
    Success:
      description: success message
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessResponse'
    UnknownError_2:
      description: unknown error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
  parameters:
    traceSourceId:
      description: Trace Source ID
      in: path
      name: traceSourceId
      required: true
      schema:
        format: uuid
        type: string
    TraceSourceTokenHeader:
      name: X-Trace-Source-Token
      description: Optional header to authenticate the trace source
      in: header
      required: false
      schema:
        type: string
x-refined-from:
- apiclarity-global-openapi.gen.yml
- apiclarity-plugins-telemetry-swagger.yml

APIClarity Control API

Operations 5

Documentation

Specifications

SDKs

Other Resources