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

Captured API traffic events.

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

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

This API exposes 4 operations across 4 paths, and defines 7 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.

4 operations 4 paths 7 schemas 4 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 API Events 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 4

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

API Events 4

Captured API traffic events.

GET
/apiEvents
Get API events
33 params → 200default
GET
/apiEvents/{eventId}
Get API event
1 param → 200default
GET
/apiEvents/{eventId}/reconstructedSpecDiff
Get API event reconstructed spec diff
1 param → 200default
GET
/apiEvents/{eventId}/providedSpecDiff
Get API event provided spec diff
1 param → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ApiEvent (17 properties), ModuleAlert (3 properties), ApiEventSpecDiff (3 properties). Each schema is shown below with its type and property counts.

ApiEventSpecDiff
object
3 properties 2 required
DiffType
string
HttpMethod
string
AlertSeverityEnum
string
Level of alert
ModuleAlert
object
3 properties
ApiEvent
object
17 properties
ApiType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apiclarity-api-events-api-openapi.yml Raw ↑

Other APIs APIClarity publishes across the network.

APIClarity API Inventory API
APIClarity Control API
APIClarity Features API