Test Rate Limit Check Plugins API

The Plugins API from Test Rate Limit Check — 1 operation(s) for plugins.

OpenAPI Specification

test-rate-limit-check-plugins-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Kong Gateway Admin API (Rate Limit Check) Consumers Plugins API
  description: Subset of the Kong Gateway Admin API used for configuring and validating rate limiting on services, routes, consumers, and plugins. Exposed by a self-hosted Kong Gateway control plane on port 8001 (HTTP) or 8444 (HTTPS).
  version: 3.x
  contact:
    name: Kong Gateway Admin API
    url: https://developer.konghq.com/admin-api/
servers:
- url: http://localhost:8001
  description: Default Kong Admin API (HTTP)
- url: https://localhost:8444
  description: Default Kong Admin API (HTTPS)
security:
- rbacToken: []
- {}
tags:
- name: Plugins
paths:
  /plugins:
    get:
      summary: List plugins (including rate-limiting plugins)
      operationId: listPlugins
      responses:
        '200':
          description: Plugins listed.
      tags:
      - Plugins
    post:
      summary: Create a plugin (e.g. rate-limiting)
      operationId: createPlugin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: rate-limiting
                config:
                  type: object
      responses:
        '201':
          description: Plugin created.
      tags:
      - Plugins
components:
  securitySchemes:
    rbacToken:
      type: apiKey
      in: header
      name: Kong-Admin-Token
      description: RBAC admin token issued by Kong Gateway when RBAC is enabled.