Apache APISIX Plugin Metadata API

Manage metadata for individual plugins.

Operations 3

GET /plugin_metadata/{plugin_name} Apache APISIX Get Plugin Metadata #
PUT /plugin_metadata/{plugin_name} Apache APISIX Create or Update Plugin Metadata #
DELETE /plugin_metadata/{plugin_name} Apache APISIX Delete Plugin Metadata #

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-plugin-metadata-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-plugin-metadata-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache APISIX Admin Consumer Groups Plugin Metadata API
  description: The Apache APISIX Admin API provides a RESTful interface to dynamically control and configure your deployed Apache APISIX instance. It allows management of routes, services, upstreams, consumers, SSL certificates, global rules, plugin configurations, consumer groups, secrets, and more. By default, the Admin API listens on port 9180 and requires API key authentication via the X-API-KEY header.
  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
servers:
- url: http://127.0.0.1:9180/apisix/admin
  description: Default local Admin API server
security:
- apiKey: []
tags:
- name: Plugin Metadata
  description: Manage metadata for individual plugins.
paths:
  /plugin_metadata/{plugin_name}:
    get:
      operationId: getPluginMetadata
      summary: Apache APISIX Get Plugin Metadata
      description: Fetches metadata for the specified plugin.
      tags:
      - Plugin Metadata
      parameters:
      - $ref: '#/components/parameters/PluginName'
      responses:
        '200':
          description: Successful response with plugin metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceResponse'
        '404':
          description: Plugin metadata not found.
    put:
      operationId: createOrUpdatePluginMetadata
      summary: Apache APISIX Create or Update Plugin Metadata
      description: Creates or updates metadata for the specified plugin.
      tags:
      - Plugin Metadata
      parameters:
      - $ref: '#/components/parameters/PluginName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Plugin-specific metadata configuration.
      responses:
        '200':
          description: Plugin metadata updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceResponse'
        '201':
          description: Plugin metadata created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCreated'
    delete:
      operationId: deletePluginMetadata
      summary: Apache APISIX Delete Plugin Metadata
      description: Removes metadata for the specified plugin.
      tags:
      - Plugin Metadata
      parameters:
      - $ref: '#/components/parameters/PluginName'
      responses:
        '200':
          description: Plugin metadata deleted successfully.
        '404':
          description: Plugin metadata not found.
components:
  parameters:
    PluginName:
      name: plugin_name
      in: path
      required: true
      description: Name of the plugin.
      schema:
        type: string
  schemas:
    ResourceCreated:
      type: object
      description: Response wrapper for a newly created resource.
      properties:
        key:
          type: string
          description: The etcd key path for the created resource.
        value:
          type: object
          description: The created resource configuration.
    ResourceResponse:
      type: object
      description: Standard response wrapper for a single resource.
      properties:
        key:
          type: string
          description: The etcd key path for the resource.
        value:
          type: object
          description: The resource configuration.
        modifiedIndex:
          type: integer
          description: The etcd modification index.
        createdIndex:
          type: integer
          description: The etcd creation index.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Admin API key for authentication.