APIClarity

APIClarity Plugins Telemetry API

The Swagger 2.0 contract every APIClarity traffic-source plugin implements to push captured traffic into a deployment — POST /telemetry, GET /hostsToTrace and POST /control/newDiscoveredAPIs. Authenticated with the optional X-Trace-Source-Token header issued when a trace source is registered. Implemented by the Istio WASM filter, the tap DaemonSet, and the Kong, Tyk, Kuma and OpenTelemetry Collector plugins.

Documentation GitHub OpenAPI

Operations 3

POST /telemetry Post an http telemetry

GET /hostsToTrace Get a list of hosts to trace

POST /control/newDiscoveredAPIs Allows a client to notify APIClarity about new APIs.

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-plugins-telemetry-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

swagger: "2.0"
info:
  version: "1.0.0"
  title: "APIClarity Plugins telemetries API"

basePath: /api

schemes:
  - http

consumes: [ "application/json" ]
produces: [ "application/json" ]

paths:
  /telemetry:
    post:
      summary: 'Post an http telemetry'
      parameters:
        - $ref: '#/parameters/TraceSourceTokenHeader'
        - in: 'body'
          name: 'body'
          required: true
          schema:
            description: 'Telemetry'
            $ref: '#/definitions/Telemetry'
      responses:
        '200':
          description: 'Success'
          schema:
            $ref: '#/responses/Success'
        default:
          $ref: '#/responses/UnknownError'

  /hostsToTrace:
    get:
      summary: 'Get a list of hosts to trace'
      parameters:
        - $ref: '#/parameters/TraceSourceTokenHeader'
      responses:
        '200':
          description: 'Success'
          schema:
            $ref: '#/definitions/HostsToTrace'
        default:
          $ref: '#/responses/UnknownError'

  /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.'
      parameters:
        - $ref: '#/parameters/TraceSourceTokenHeader'
        - in: 'body'
          name: 'body'
          description: 'List of new discovered APIs'
          required: true
          schema:
            type: 'object'
            required:
              - hosts
            properties:
              hosts:
                type: 'array'
                description: 'List of discovered APIs, format of hostname:port'
                items:
                  type: 'string'
      responses:
        '200':
          description: 'Success'
          schema:
            $ref: '#/responses/Success'
        default:
          $ref: '#/responses/UnknownError'

definitions:
  Telemetry:
    type: 'object'
    properties:
      requestID:
        type: 'string'
      scheme:
        type: 'string'
      destinationAddress:
        type: 'string'
      destinationNamespace:
        type: 'string'
      sourceAddress:
        type: 'string'
      request:
        $ref: '#/definitions/Request'
      response:
        $ref: '#/definitions/Response'

  Request:
    type: 'object'
    properties:
      method:
        type: 'string'
      path:
        type: 'string'
      host:
        type: 'string'
      common:
        $ref: '#/definitions/Common'

  Response:
    type: 'object'
    properties:
      statusCode:
        type: 'string'
      common:
        $ref: '#/definitions/Common'

  Common:
    type: 'object'
    properties:
      version:
        type: 'string'
      headers:
        type: 'array'
        items:
          $ref: '#/definitions/Header'
      body:
        type: 'string'
        format: 'byte'
      TruncatedBody:
        type: 'boolean'
      time:
        description: 'Time since epoch (milliseconds)'
        type: 'integer'
        format: int64

  Header:
    type: 'object'
    properties:
      key:
        type: 'string'
      value:
        type: 'string'

  ApiResponse:
    description: 'An object that is return in all cases of failures.'
    type: 'object'
    properties:
      message:
        type: 'string'


  SuccessResponse:
    description: 'An object that is return in cases of success that return nothing.'
    type: 'object'
    properties:
      message:
        type: 'string'

  HostsList:
    description: 'List of hosts'
    type: 'array'
    items:
      type: string
  
  HostsToTrace:
    description: 'List of hosts to trace'
    type: 'object'
    properties:
      hosts:
        $ref: '#/definitions/HostsList'
    required:
      - hosts

responses:
  UnknownError:
    description: 'unknown error'
    schema:
      $ref: '#/definitions/ApiResponse'
  Success:
    description: 'success message'
    schema:
      $ref: '#/definitions/SuccessResponse'

parameters:
  TraceSourceTokenHeader:
    name: 'X-Trace-Source-Token'
    description: 'Optional header to authenticate the trace source'
    in: 'header'
    type: 'string'
    required: false

APIClarity Plugins Telemetry API

Operations 3

Documentation

Specifications

SDKs

Other Resources