Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIClarity Control API

Control-plane endpoints for trace sources and discovered APIs.

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

Tagged areas include Control. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a GitHub repository.

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

Requests are made against a single base URL, http://localhost:8080/api.

5 operations 3 paths 3 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
http://localhost:8080/api
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

APIClarity Control API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

  • BearerAuth — APIClarity is typically deployed inside a Kubernetes cluster behind an ingress that enforces authentication. When exposed externally, deployments commonly requ…

Paths & Operations 5

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

Control 5

Control-plane endpoints for trace sources and discovered APIs.

POST
/control/newDiscoveredAPIs
Allows a client to notify APIClarity about new APIs.
body → 200default
GET
/control/traceSources
List of configured trace sources
→ 200default
POST
/control/traceSources
Create a new Trace Source
body → 201default
GET
/control/traceSources/{traceSourceId}
Get Trace Source information
1 param → 200404default
DELETE
/control/traceSources/{traceSourceId}
Delete a Trace Source
1 param → 204404default

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TraceSource (6 properties), ApiResponse (1 property). Each schema is shown below with its type and property counts.

TraceSource
object
A Source which is sending traces to APIClarity
6 properties 2 required
ApiResponse
object
An object that is return in all cases of failures.
1 property
TraceSourceType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-control-api-openapi.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity API Inventory API
APIClarity Features API