How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

APIClarity Plugins Telemetry API is one of 11 APIs that APIClarity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Telemetry, Traffic Capture, and Plugins. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, API documentation, and a GitHub repository.

This API exposes 3 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://apiclarity-server/api.

3 operations 3 paths 9 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://apiclarity-server/api
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 3
POST
/telemetry
Post an http telemetry
2 params → 200default
GET
/hostsToTrace
Get a list of hosts to trace
1 param → 200default
POST
/control/newDiscoveredAPIs
Allows a client to notify APIClarity about new APIs.
2 params → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Telemetry (7 properties), Common (5 properties), Request (4 properties), Response (2 properties). Each schema is shown below with its type and property counts.

Telemetry
object
7 properties
Request
object
4 properties
Response
object
2 properties
Common
object
5 properties
Header
object
2 properties
ApiResponse
object
An object that is return in all cases of failures.
1 property
SuccessResponse
object
An object that is return in cases of success that return nothing.
1 property
HostsList
array
List of hosts
HostsToTrace
object
List of hosts to trace
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-plugins-telemetry-swagger.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity API Inventory API
APIClarity Control API
APIClarity Features API
APIClarity BFLA Module API
APIClarity Fuzzer Module API
APIClarity Trace Analyzer Module API
APIClarity Spec Differ Module API
APIClarity Spec Reconstructor Module API
APIClarity Notifications API
Where this information came from

This is an independent, third-party profile of APIClarity Plugins Telemetry API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.