APIClarity

APIClarity API Inventory API

The ApiInventory API from APIClarity — 11 operation(s) for apiinventory.

GitHub OpenAPI

Operations 13

GET /apiInventory Get API inventory #
POST /apiInventory Create API inventory item #
GET /apiInventory/{apiId}/apiInfo Get api info from apiId #
GET /apiInventory/{apiId}/provided_swagger.json Get provided API spec json file #
GET /apiInventory/{apiId}/reconstructed_swagger.json Get reconstructed API spec json file #
GET /apiInventory/{apiId}/specs Get provided and reconstructed open api specs for a specific API #
DELETE /apiInventory/{apiId}/specs/providedSpec Unset a provided spec for a specific API #
PUT /apiInventory/{apiId}/specs/providedSpec Add or edit a spec for a specific API #
DELETE /apiInventory/{apiId}/specs/reconstructedSpec Unset a reconstructed spec for a specific API #
GET /apiInventory/{apiId}/suggestedReview Get reconstructed spec for review #
POST /apiInventory/{reviewId}/approvedReview Apply the approved review to create the reconstructed spec #
GET /apiInventory/apiId/fromHostAndPort Get apiId from host and port #
GET /apiInventory/apiId/fromHostAndPortAndTraceSourceID Get apiId from host and port and Trace Source ID #

Documentation

📖
Documentation
https://github.com/openclarity/apiclarity#readme
📖
GettingStarted
https://github.com/openclarity/apiclarity#getting-started
📖
Documentation
https://github.com/openclarity/apiclarity/blob/master/backend/pkg/modules/internal/bfla/README.md
📖
Documentation
https://github.com/openclarity/apiclarity/blob/master/backend/pkg/modules/internal/traceanalyzer/README.md
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/authentication/apiclarity-authentication.yml
📖
Documentation
https://github.com/openclarity/apiclarity/tree/master/plugins
📖
Documentation
https://github.com/openclarity/apiclarity/tree/master/api3#apiclarity-notification-specification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/openapi/apiclarity-apiinventory-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/openclarity/apiclarity

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/apiclarity/refs/heads/main/asyncapi/apiclarity-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apiclarity-apiinventory-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apiclarity-apiinventory-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: APIClarity API Inventory API
  version: 1.0.0
servers:
- url: /api
tags:
- name: ApiInventory
paths:
  /apiInventory:
    get:
      parameters:
      - $ref: '#/components/parameters/apiType'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/apiInventorySortKey'
      - $ref: '#/components/parameters/sortDir'
      - $ref: '#/components/parameters/apiNameIsFilter'
      - $ref: '#/components/parameters/apiNameIsNotFilter'
      - $ref: '#/components/parameters/apiNameStartsWithFilter'
      - $ref: '#/components/parameters/apiNameEndsWithFilter'
      - $ref: '#/components/parameters/apiNameContainsFilter'
      - $ref: '#/components/parameters/portIsFilter'
      - $ref: '#/components/parameters/portIsNotFilter'
      - $ref: '#/components/parameters/hasProvidedSpecFilter'
      - $ref: '#/components/parameters/hasReconstructedSpecFilter'
      - $ref: '#/components/parameters/apiIdFilter'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    description: List of filtered APIs in the given page. List length must be lower or equal to pageSize
                    items:
                      $ref: ../common/openapi.yaml#/components/schemas/ApiInfo
                    type: array
                  total:
                    description: Total filtered APIs count
                    type: integer
                required:
                - total
                type: object
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get API inventory
      tags:
      - ApiInventory
      operationId: getApiInventory
      x-operation-id-source: derived
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../common/openapi.yaml#/components/schemas/ApiInfoWithType
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiInfo
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Create API inventory item
      tags:
      - ApiInventory
      operationId: postApiInventory
      x-operation-id-source: derived
  /apiInventory/{apiId}/apiInfo:
    get:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiInfoWithType
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get api info from apiId
      tags:
      - ApiInventory
      operationId: getApiInventoryByApiIdApiInfo
      x-operation-id-source: derived
  /apiInventory/{apiId}/provided_swagger.json:
    get:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                description: spec in json format
                type: object
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get provided API spec json file
      tags:
      - ApiInventory
      operationId: getApiInventoryByApiIdProvidedSwaggerJson
      x-operation-id-source: derived
  /apiInventory/{apiId}/reconstructed_swagger.json:
    get:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                description: spec in json format
                type: object
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get reconstructed API spec json file
      tags:
      - ApiInventory
      operationId: getApiInventoryByApiIdReconstructedSwaggerJson
      x-operation-id-source: derived
  /apiInventory/{apiId}/specs:
    get:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/OpenApiSpecs
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get provided and reconstructed open api specs for a specific API
      tags:
      - ApiInventory
      operationId: getApiInventoryByApiIdSpecs
      x-operation-id-source: derived
  /apiInventory/{apiId}/specs/providedSpec:
    delete:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/SuccessResponse
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Unset a provided spec for a specific API
      tags:
      - ApiInventory
      operationId: deleteApiInventoryByApiIdSpecsProvidedSpec
      x-operation-id-source: derived
    put:
      parameters:
      - $ref: '#/components/parameters/apiId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../common/openapi.yaml#/components/schemas/rawSpec
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/rawSpec
          description: Success
        '400':
          content:
            application/json:
              schema:
                type: string
          description: Spec validation failure
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Add or edit a spec for a specific API
      tags:
      - ApiInventory
      operationId: putApiInventoryByApiIdSpecsProvidedSpec
      x-operation-id-source: derived
  /apiInventory/{apiId}/specs/reconstructedSpec:
    delete:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/SuccessResponse
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Unset a reconstructed spec for a specific API
      tags:
      - ApiInventory
      operationId: deleteApiInventoryByApiIdSpecsReconstructedSpec
      x-operation-id-source: derived
  /apiInventory/{apiId}/suggestedReview:
    get:
      parameters:
      - $ref: '#/components/parameters/apiId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/SuggestedReview
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get reconstructed spec for review
      tags:
      - ApiInventory
      operationId: getApiInventoryByApiIdSuggestedReview
      x-operation-id-source: derived
  /apiInventory/{reviewId}/approvedReview:
    post:
      parameters:
      - $ref: '#/components/parameters/reviewId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: ../common/openapi.yaml#/components/schemas/ApprovedReview
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/SuccessResponse
          description: Success
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Apply the approved review to create the reconstructed spec
      tags:
      - ApiInventory
      operationId: postApiInventoryByReviewIdApprovedReview
      x-operation-id-source: derived
  /apiInventory/apiId/fromHostAndPort:
    get:
      parameters:
      - $ref: '#/components/parameters/host'
      - $ref: '#/components/parameters/port'
      responses:
        '200':
          content:
            application/json:
              schema:
                description: api id
                format: uint32
                type: integer
          description: Success
        '404':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: API ID Not Found
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get apiId from host and port
      tags:
      - ApiInventory
      operationId: getApiInventoryApiIdFromHostAndPort
      x-operation-id-source: derived
  /apiInventory/apiId/fromHostAndPortAndTraceSourceID:
    get:
      parameters:
      - $ref: '#/components/parameters/host'
      - $ref: '#/components/parameters/port'
      - $ref: '#/components/parameters/traceSourceIdQuery'
      responses:
        '200':
          content:
            application/json:
              schema:
                description: api id
                format: uint32
                type: integer
          description: Success
        '404':
          content:
            application/json:
              schema:
                $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
          description: API ID Not Found
        default:
          $ref: '#/components/responses/UnknownError'
      summary: Get apiId from host and port and Trace Source ID
      tags:
      - ApiInventory
      operationId: getApiInventoryApiIdFromHostAndPortAndTraceSourceID
      x-operation-id-source: derived
components:
  parameters:
    port:
      description: api port
      in: query
      name: port
      required: true
      schema:
        type: string
    apiIdFilter:
      description: api id to return
      in: query
      name: apiId
      schema:
        type: string
    page:
      description: Page number of the query
      in: query
      name: page
      required: true
      schema:
        type: integer
    portIsFilter:
      in: query
      name: port[is]
      schema:
        items:
          type: string
        type: array
    sortDir:
      description: Sorting direction
      in: query
      name: sortDir
      schema:
        default: ASC
        enum:
        - ASC
        - DESC
        type: string
    apiNameIsFilter:
      in: query
      name: name[is]
      schema:
        items:
          type: string
        type: array
    pageSize:
      description: Maximum items to return
      in: query
      name: pageSize
      required: true
      schema:
        maximum: 50
        minimum: 1
        type: integer
    apiNameIsNotFilter:
      in: query
      name: name[isNot]
      schema:
        items:
          type: string
        type: array
    traceSourceIdQuery:
      description: Trace Source ID
      in: query
      name: traceSourceId
      required: true
      schema:
        format: uuid
        type: string
    hasProvidedSpecFilter:
      in: query
      name: hasProvidedSpec[is]
      schema:
        type: boolean
    apiInventorySortKey:
      description: Sort key
      in: query
      name: sortKey
      required: true
      schema:
        $ref: ../common/openapi.yaml#/components/schemas/ApiInventorySortKey
    reviewId:
      in: path
      name: reviewId
      required: true
      schema:
        format: uint32
        type: integer
    host:
      description: api host name
      in: query
      name: host
      required: true
      schema:
        type: string
    apiNameStartsWithFilter:
      in: query
      name: name[start]
      schema:
        type: string
    portIsNotFilter:
      in: query
      name: port[isNot]
      schema:
        items:
          type: string
        type: array
    apiNameContainsFilter:
      in: query
      name: name[contains]
      schema:
        items:
          type: string
        type: array
    apiNameEndsWithFilter:
      in: query
      name: name[end]
      schema:
        type: string
    hasReconstructedSpecFilter:
      in: query
      name: hasReconstructedSpec[is]
      schema:
        type: boolean
    apiType:
      description: API type [INTERNAL or EXTERNAL]
      in: query
      name: type
      required: true
      schema:
        $ref: ../common/openapi.yaml#/components/schemas/ApiTypeEnum
    apiId:
      in: path
      name: apiId
      required: true
      schema:
        format: uint32
        type: integer
  responses:
    UnknownError:
      content:
        application/json:
          schema:
            $ref: ../common/openapi.yaml#/components/schemas/ApiResponse
      description: unknown error