Apache APISIX Diagnostics API

Runtime diagnostic operations.

OpenAPI Specification

apache-apisix-diagnostics-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Apache APISIX Admin Consumer Groups Diagnostics 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: Diagnostics
  description: Runtime diagnostic operations.
paths:
  /v1/gc:
    post:
      operationId: triggerGC
      summary: Apache APISIX Trigger Garbage Collection
      description: Triggers a full garbage collection cycle in the Lua VM.
      tags:
      - Diagnostics
      responses:
        '200':
          description: GC triggered successfully.
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Admin API key for authentication.