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 Features API

Enabled features in the deployment.

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

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

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 GET

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 Features 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Features 1

Enabled features in the deployment.

GET
/features
Get the list of APIClarity features and for each feature the list of API hosts (in the form 'host:port') the feature requires to get trace for
→ 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are APIClarityFeature (3 properties), HostsToTraceForComponent (2 properties), HostsToTraceForTraceSource (2 properties), APIClarityFeatureList (1 property). Each schema is shown below with its type and property counts.

APIClarityFeature
object
Description of APIClarity feature and the list of API hosts (Group by trace sources, in the form 'host:port') the feature requires to get trace for
3 properties 1 required
HostsToTraceForTraceSource
object
list of API hosts (in the form 'host:port') managed by a traceSource
2 properties
APIClarityFeatureEnum
string
APIClarity Feature Name
HostsToTraceForComponent
object
List of trace sources for a component, with theirs list of API hosts to get trace for
2 properties
APIClarityFeatureList
object
List of APIClarity features and for each feature the list of API hosts (Group by trace sources, in the form 'host:port') the feature requires to get trace for
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-features-api-openapi.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity API Inventory API
APIClarity Control API