Apache Knox Topologies API

Gateway topology management

Operations 6

GET /api/v1/topologies Apache knox Apache Knox List Topologies #
POST /api/v1/topologies Apache knox Apache Knox Create Topology #
GET /api/v1/topologies/{topologyName} Apache knox Apache Knox Get Topology #
DELETE /api/v1/topologies/{topologyName} Apache knox Apache Knox Delete Topology #
GET /api/v1/topologies/{topologyName}/urls Apache knox Apache Knox Get Topology URLs #
GET /api/v1/version Apache knox Apache Knox Get Version #

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/apache-knox-topologies-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.

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

OpenAPI Specification

apache-knox-topologies-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache Knox Admin REST Descriptors Topologies API
  description: REST API for Apache Knox gateway administration including topology management, service discovery, token management, and audit operations.
  version: 2.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    email: user@knox.apache.org
servers:
- url: https://localhost:8443/gateway/admin
  description: Apache Knox Admin API
security:
- basicAuth: []
tags:
- name: Topologies
  description: Gateway topology management
paths:
  /api/v1/topologies:
    get:
      operationId: listTopologies
      summary: Apache knox Apache Knox List Topologies
      description: List all configured gateway topologies.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: List of topologies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopologyList'
              examples:
                listTopologies200Example:
                  summary: Default listTopologies 200 response
                  x-microcks-default: true
                  value:
                    topologies: {}
    post:
      operationId: createTopology
      summary: Apache knox Apache Knox Create Topology
      description: Create or update a gateway topology.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Topology'
            examples:
              createTopologyRequestExample:
                summary: Default createTopology request
                x-microcks-default: true
                value:
                  name: sandbox
                  uri: https://localhost:8443/gateway/sandbox
                  timestamp: 1718153645993
      responses:
        '200':
          description: Topology created or updated
  /api/v1/topologies/{topologyName}:
    get:
      operationId: getTopology
      summary: Apache knox Apache Knox Get Topology
      description: Get details of a specific topology.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: topologyName
        in: path
        required: true
        schema:
          type: string
        example: sandbox
      responses:
        '200':
          description: Topology details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Topology'
              examples:
                getTopology200Example:
                  summary: Default getTopology 200 response
                  x-microcks-default: true
                  value:
                    name: sandbox
                    uri: https://localhost:8443/gateway/sandbox
                    timestamp: 1718153645993
        '404':
          description: Topology not found
    delete:
      operationId: deleteTopology
      summary: Apache knox Apache Knox Delete Topology
      description: Delete a gateway topology.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: topologyName
        in: path
        required: true
        schema:
          type: string
        example: sandbox
      responses:
        '200':
          description: Topology deleted
  /api/v1/topologies/{topologyName}/urls:
    get:
      operationId: getTopologyUrls
      summary: Apache knox Apache Knox Get Topology URLs
      description: Get all service URLs for a topology.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: topologyName
        in: path
        required: true
        schema:
          type: string
        example: sandbox
      responses:
        '200':
          description: Topology service URLs
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                getTopologyUrls200Example:
                  summary: Default getTopologyUrls 200 response
                  x-microcks-default: true
                  value: {}
  /api/v1/version:
    get:
      operationId: getVersion
      summary: Apache knox Apache Knox Get Version
      description: Get the Knox gateway version information.
      tags:
      - Topologies
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Knox version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnoxVersion'
              examples:
                getVersion200Example:
                  summary: Default getVersion 200 response
                  x-microcks-default: true
                  value:
                    version: 2.0.0
                    hash: abc123def
components:
  schemas:
    KnoxVersion:
      type: object
      description: Knox gateway version information
      properties:
        version:
          type: string
          description: Knox version string
          example: 2.0.0
        hash:
          type: string
          description: Build hash
          example: abc123def
    TopologyList:
      type: object
      description: List of Knox topologies
      properties:
        topologies:
          type: object
          properties:
            topology:
              type: array
              items:
                $ref: '#/components/schemas/Topology'
    Topology:
      type: object
      description: A Knox gateway topology
      properties:
        name:
          type: string
          description: Topology name
          example: sandbox
        uri:
          type: string
          description: Topology gateway URL
          example: https://localhost:8443/gateway/sandbox
        timestamp:
          type: integer
          description: Last modified timestamp
          example: 1718153645993
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic