Apache APISIX Schema API

Validate resource configurations against APISIX schemas.

Operations 3

POST /schema/validate/{resource} Apache APISIX Validate Resource Schema #
GET /v1/schema Apache APISIX Get APISIX JSON Schema #
GET /v1/schema/plugins/{plugin_name} Apache APISIX Get a Specific Plugin Schema #

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-apisix-schema-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-apisix-schema-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache Apisix Schema API
  version: 3.14.0
  contact:
    name: Apache APISIX
    url: https://apisix.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged Schema across 2 of this provider''s published API definitions: apache-apisix-admin-api-openapi.yml, apache-apisix-control-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1:9180/apisix/admin
  description: Default local Admin API server
- url: http://127.0.0.1:9090
  description: Default local Control API server
tags:
- name: Schema
  description: Validate resource configurations against APISIX schemas.
paths:
  /schema/validate/{resource}:
    post:
      operationId: validateSchema
      summary: Apache APISIX Validate Resource Schema
      description: Validates the given request body against the schema of the specified resource type.
      tags:
      - Schema
      parameters:
      - name: resource
        in: path
        required: true
        description: The resource type to validate against (e.g. routes, services, upstreams).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: The resource configuration to validate.
      responses:
        '200':
          description: Validation successful.
        '400':
          description: Validation failed with error details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_msg:
                    type: string
                    description: Validation error message.
      security:
      - apiKey: []
    servers:
    - url: http://127.0.0.1:9180/apisix/admin
      description: Default local Admin API server
  /v1/schema:
    get:
      operationId: getSchema
      summary: Apache APISIX Get APISIX JSON Schema
      description: Returns the full JSON schema used by the APISIX instance, including main configuration schemas and all plugin schemas.
      tags:
      - Schema
      responses:
        '200':
          description: Successful response with the complete JSON schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  main:
                    type: object
                    description: Main configuration schemas for routes, upstreams, etc.
                  plugins:
                    type: object
                    description: Schemas for all enabled plugins.
    servers:
    - url: http://127.0.0.1:9090
      description: Default local Control API server
  /v1/schema/plugins/{plugin_name}:
    get:
      operationId: getPluginSchema
      summary: Apache APISIX Get a Specific Plugin Schema
      description: Returns the JSON schema for the specified plugin.
      tags:
      - Schema
      parameters:
      - name: plugin_name
        in: path
        required: true
        description: The name of the plugin.
        schema:
          type: string
      responses:
        '200':
          description: Successful response with the plugin schema.
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Plugin not found.
    servers:
    - url: http://127.0.0.1:9090
      description: Default local Control API server
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Admin API key for authentication.
x-refined-from:
- apache-apisix-admin-api-openapi.yml
- apache-apisix-control-api-openapi.yml