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

Discovered APIs and their reconstructed specifications.

APIClarity API Inventory 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 Inventory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and a GitHub repository.

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

17 operations 15 paths 20 schemas 2 DELETE12 GET2 POST1 PUT

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 Inventory 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 17

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

API Inventory 17

Discovered APIs and their reconstructed specifications.

GET
/apiInventory
Get API inventory
15 params → 200default
POST
/apiInventory
Create API inventory item
body → 200default
GET
/dashboard/apiUsage
Get API usage
2 params → 200default
GET
/dashboard/apiUsage/mostUsed
Get most used APIs
→ 200default
GET
/dashboard/apiUsage/latestDiffs
Get latest spec diffs
→ 200default
GET
/apiInventory/{apiId}/specs
Get provided and reconstructed open api specs for a specific API
1 param → 200default
PUT
/apiInventory/{apiId}/specs/providedSpec
Add or edit a spec for a specific API
1 param body → 201400default
DELETE
/apiInventory/{apiId}/specs/providedSpec
Unset a provided spec for a specific API
1 param → 200default
DELETE
/apiInventory/{apiId}/specs/reconstructedSpec
Unset a reconstructed spec for a specific API
1 param → 200default
GET
/apiInventory/{apiId}/reconstructed_swagger.json
Get reconstructed API spec json file
1 param → 200default
GET
/apiInventory/{apiId}/apiInfo
Get api info from apiId
1 param → 200default
GET
/apiInventory/apiId/fromHostAndPort
Get apiId from host and port
2 params → 200404default
GET
/apiInventory/apiId/fromHostAndPortAndTraceSourceID
Get apiId from host and port and Trace Source ID
3 params → 200404default
GET
/apiInventory/{apiId}/provided_swagger.json
Get provided API spec json file
1 param → 200default
GET
/apiUsage/hitCount
Get a hit count within a selected timeframe for the filtered API events
28 params → 200default
GET
/apiInventory/{apiId}/suggestedReview
Get reconstructed spec for review
1 param → 200default
POST
/apiInventory/{reviewId}/approvedReview
Apply the approved review to create the reconstructed spec
1 param body → 200default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ApiInfo (9 properties), ApiCount (5 properties), SpecDiffTime (4 properties), ApiUsages (3 properties). Each schema is shown below with its type and property counts.

SpecTag
object
3 properties
ApiCount
object
5 properties
SpecInfo
object
An object containing info about a spec
1 property
ApiUsage
object
2 properties
HitCount
object
2 properties
ReviewPathItem
object
2 properties
ApiUsages
object
3 properties
DiffType
string
ApiResponse
object
An object that is return in all cases of failures.
1 property
SpecDiffTime
object
4 properties
ApiEventPathAndMethods
object
2 properties
rawSpec
object
spec in json or yaml format
2 properties
HttpMethod
string
ApiInfoWithType
object
ApprovedReview
object
2 properties
OpenApiSpecs
object
An object representing the provided and reconstructed API specs
2 properties
MethodAndPath
object
3 properties
SuggestedReview
object
2 properties
ApiInfo
object
9 properties
ApiType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs APIClarity publishes across the network.

APIClarity API Events API
APIClarity Control API
APIClarity Features API