openapi: 3.1.0 info: title: Kong Gateway Admin API description: >- The Kong Gateway Admin API is an internal RESTful API for administration purposes. It provides full control over a Kong Gateway instance, enabling management of services, routes, plugins, consumers, and upstream targets. By default the Admin API listens on port 8001. version: 3.13.0 contact: name: Kong Inc. url: https://konghq.com email: support@konghq.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://konghq.com/wp-content/uploads/2018/05/kong-logo.png servers: - url: http://localhost:8001 description: Default Admin API (HTTP) - url: https://localhost:8444 description: Default Admin API (HTTPS) tags: - name: Information description: General information about the Kong Gateway node. - name: Services description: >- A Service object represents each of your own upstream services that Kong Gateway proxies. Services are the core entities used to configure the upstream URL that incoming requests are forwarded to. - name: Routes description: >- A Route defines rules to match client requests and is associated with a Service. When a request matches a Route, Kong proxies it to the associated Service. - name: Consumers description: >- A Consumer represents a developer or machine using the API. Consumers are used to control who can access APIs through authentication plugins. - name: Plugins description: >- A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins can be applied globally, to a Service, a Route, or a Consumer. - name: Upstreams description: >- An Upstream object represents a virtual hostname and can be used to health-check, circuit-break, and load-balance incoming requests over multiple target backend services. - name: Targets description: >- A Target is an IP address or hostname with a port that identifies an instance of a backend service behind an Upstream. - name: Certificates description: >- A Certificate object represents a public certificate that can be used for TLS termination of encrypted requests. - name: SNIs description: >- An SNI object represents a many-to-one mapping of hostnames to a Certificate. A Certificate can have many hostnames associated with it. - name: Tags description: >- Tags are strings associated with entities for grouping and filtering. paths: /: get: operationId: getNodeInformation summary: Retrieve Node Information description: >- Returns general details about the Kong Gateway node including version, available plugins, and configuration. tags: - Information responses: '200': description: Node information retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/NodeInfo' examples: Getnodeinformation200Example: summary: Default getNodeInformation 200 response x-microcks-default: true value: version: example_value lua_version: example_value tagline: example_value hostname: example_value node_id: '500123' timers: pending: 10 running: 10 plugins: available_on_server: example_value enabled_in_cluster: - example_value configuration: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /status: get: operationId: getNodeStatus summary: Retrieve Node Status description: >- Returns usage information about the node with connection counts and database reachability. tags: - Information responses: '200': description: Node status retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/NodeStatus' examples: Getnodestatus200Example: summary: Default getNodeStatus 200 response x-microcks-default: true value: database: reachable: true memory: workers_lua_vms: - http_allocated_gc: example_value pid: '500123' lua_shared_dicts: example_value server: connections_accepted: 10 connections_active: 10 connections_handled: 10 connections_reading: 10 connections_waiting: 10 connections_writing: 10 total_requests: 10 configuration_hash: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /services: get: operationId: listServices summary: List All Services description: Returns a paginated list of all registered Service entities. tags: - Services parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of services. content: application/json: schema: $ref: '#/components/schemas/ServiceList' examples: Listservices200Example: summary: Default listServices 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: {} client_certificate: {} tls_verify: true tls_verify_depth: 10 ca_certificates: {} enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createService summary: Create a New Service description: Creates a new Service entity. tags: - Services requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceInput' examples: CreateserviceRequestExample: summary: Default createService request x-microcks-default: true value: name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true responses: '201': description: Service created successfully. content: application/json: schema: $ref: '#/components/schemas/Service' examples: Createservice201Example: summary: Default createService 201 response x-microcks-default: true value: id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '409': description: Conflict - a Service with the same name already exists. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Createservice409Example: summary: Default createService 409 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/{service_id_or_name}: parameters: - $ref: '#/components/parameters/ServiceIdOrName' get: operationId: getService summary: Retrieve a Service description: Returns details of a specific Service by ID or name. tags: - Services responses: '200': description: Service retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Service' examples: Getservice200Example: summary: Default getService 200 response x-microcks-default: true value: id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Service not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getservice404Example: summary: Default getService 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateService summary: Update a Service description: Updates an existing Service entity with partial data. tags: - Services requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceInput' examples: UpdateserviceRequestExample: summary: Default updateService request x-microcks-default: true value: name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true responses: '200': description: Service updated successfully. content: application/json: schema: $ref: '#/components/schemas/Service' examples: Updateservice200Example: summary: Default updateService 200 response x-microcks-default: true value: id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Service not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Updateservice404Example: summary: Default updateService 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: upsertService summary: Create or Update a Service description: >- Inserts or replaces a Service by ID or name. If a Service with the given identifier exists it is replaced; otherwise it is created. tags: - Services requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceInput' examples: UpsertserviceRequestExample: summary: Default upsertService request x-microcks-default: true value: name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true responses: '200': description: Service replaced successfully. content: application/json: schema: $ref: '#/components/schemas/Service' examples: Upsertservice200Example: summary: Default upsertService 200 response x-microcks-default: true value: id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '201': description: Service created successfully. content: application/json: schema: $ref: '#/components/schemas/Service' examples: Upsertservice201Example: summary: Default upsertService 201 response x-microcks-default: true value: id: abc123 name: Example Title protocol: http host: example_value port: 10 path: example_value retries: 10 connect_timeout: 10 write_timeout: 10 read_timeout: 10 url: https://www.example.com tags: - example_value client_certificate: id: abc123 tls_verify: true tls_verify_depth: 10 ca_certificates: - example_value enabled: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteService summary: Delete a Service description: Deletes a specific Service by ID or name. tags: - Services responses: '204': description: Service deleted successfully. '404': description: Service not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deleteservice404Example: summary: Default deleteService 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/{service_id_or_name}/routes: parameters: - $ref: '#/components/parameters/ServiceIdOrName' get: operationId: listRoutesByService summary: List Routes Associated With a Service description: Returns a paginated list of Routes associated with a given Service. tags: - Routes parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of routes for the service. content: application/json: schema: $ref: '#/components/schemas/RouteList' examples: Listroutesbyservice200Example: summary: Default listRoutesByService 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title protocols: {} methods: {} hosts: {} paths: {} headers: example_value snis: {} sources: {} destinations: {} https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: {} service: {} expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createRouteForService summary: Create a Route Associated With a Service description: Creates a new Route associated with the given Service. tags: - Routes requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteInput' examples: CreaterouteforserviceRequestExample: summary: Default createRouteForService request x-microcks-default: true value: name: Example Title protocols: - http methods: - example_value hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 10 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 responses: '201': description: Route created successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Createrouteforservice201Example: summary: Default createRouteForService 201 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '409': description: Conflict - a Route with the same name already exists. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Createrouteforservice409Example: summary: Default createRouteForService 409 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /services/{service_id_or_name}/plugins: parameters: - $ref: '#/components/parameters/ServiceIdOrName' get: operationId: listPluginsByService summary: List Plugins Associated With a Service description: Returns a paginated list of Plugins associated with a given Service. tags: - Plugins parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of plugins for the service. content: application/json: schema: $ref: '#/components/schemas/PluginList' examples: Listpluginsbyservice200Example: summary: Default listPluginsByService 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title instance_name: example_value config: example_value protocols: {} enabled: true tags: {} ordering: {} service: {} route: {} consumer: {} consumer_group: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createPluginForService summary: Create a Plugin for a Service description: Creates a new Plugin associated with the given Service. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: CreatepluginforserviceRequestExample: summary: Default createPluginForService request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '201': description: Plugin created successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Createpluginforservice201Example: summary: Default createPluginForService 201 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /routes: get: operationId: listRoutes summary: List All Routes description: Returns a paginated list of all registered Route entities. tags: - Routes parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of routes. content: application/json: schema: $ref: '#/components/schemas/RouteList' examples: Listroutes200Example: summary: Default listRoutes 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title protocols: {} methods: {} hosts: {} paths: {} headers: example_value snis: {} sources: {} destinations: {} https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: {} service: {} expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createRoute summary: Create a New Route description: Creates a new Route entity. tags: - Routes requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteInput' examples: CreaterouteRequestExample: summary: Default createRoute request x-microcks-default: true value: name: Example Title protocols: - http methods: - example_value hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 10 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 responses: '201': description: Route created successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Createroute201Example: summary: Default createRoute 201 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '409': description: Conflict - a Route with the same name already exists. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Createroute409Example: summary: Default createRoute 409 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /routes/{route_id_or_name}: parameters: - $ref: '#/components/parameters/RouteIdOrName' get: operationId: getRoute summary: Retrieve a Route description: Returns details of a specific Route by ID or name. tags: - Routes responses: '200': description: Route retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Getroute200Example: summary: Default getRoute 200 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Route not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getroute404Example: summary: Default getRoute 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateRoute summary: Update a Route description: Updates an existing Route entity with partial data. tags: - Routes requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteInput' examples: UpdaterouteRequestExample: summary: Default updateRoute request x-microcks-default: true value: name: Example Title protocols: - http methods: - example_value hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 10 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 responses: '200': description: Route updated successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Updateroute200Example: summary: Default updateRoute 200 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Route not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Updateroute404Example: summary: Default updateRoute 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: upsertRoute summary: Create or Update a Route description: Inserts or replaces a Route by ID or name. tags: - Routes requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RouteInput' examples: UpsertrouteRequestExample: summary: Default upsertRoute request x-microcks-default: true value: name: Example Title protocols: - http methods: - example_value hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 10 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 responses: '200': description: Route replaced successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Upsertroute200Example: summary: Default upsertRoute 200 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '201': description: Route created successfully. content: application/json: schema: $ref: '#/components/schemas/Route' examples: Upsertroute201Example: summary: Default upsertRoute 201 response x-microcks-default: true value: id: abc123 name: Example Title protocols: - http methods: - GET hosts: - example_value paths: - example_value headers: example_value snis: - example_value sources: - ip: example_value port: 10 destinations: - ip: example_value port: 10 https_redirect_status_code: 301 regex_priority: 10 strip_path: true path_handling: v0 preserve_host: true request_buffering: true response_buffering: true tags: - example_value service: id: abc123 expression: example_value priority: 10 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteRoute summary: Delete a Route description: Deletes a specific Route by ID or name. tags: - Routes responses: '204': description: Route deleted successfully. '404': description: Route not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deleteroute404Example: summary: Default deleteRoute 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /routes/{route_id_or_name}/plugins: parameters: - $ref: '#/components/parameters/RouteIdOrName' get: operationId: listPluginsByRoute summary: List Plugins Associated With a Route description: Returns a paginated list of Plugins associated with a given Route. tags: - Plugins parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of plugins for the route. content: application/json: schema: $ref: '#/components/schemas/PluginList' examples: Listpluginsbyroute200Example: summary: Default listPluginsByRoute 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title instance_name: example_value config: example_value protocols: {} enabled: true tags: {} ordering: {} service: {} route: {} consumer: {} consumer_group: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createPluginForRoute summary: Create a Plugin for a Route description: Creates a new Plugin associated with the given Route. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: CreatepluginforrouteRequestExample: summary: Default createPluginForRoute request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '201': description: Plugin created successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Createpluginforroute201Example: summary: Default createPluginForRoute 201 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /consumers: get: operationId: listConsumers summary: List All Consumers description: Returns a paginated list of all registered Consumer entities. tags: - Consumers parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of consumers. content: application/json: schema: $ref: '#/components/schemas/ConsumerList' examples: Listconsumers200Example: summary: Default listConsumers 200 response x-microcks-default: true value: data: - id: abc123 username: example_value custom_id: '500123' tags: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createConsumer summary: Create a New Consumer description: Creates a new Consumer entity. tags: - Consumers requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerInput' examples: CreateconsumerRequestExample: summary: Default createConsumer request x-microcks-default: true value: username: example_value custom_id: '500123' tags: - example_value responses: '201': description: Consumer created successfully. content: application/json: schema: $ref: '#/components/schemas/Consumer' examples: Createconsumer201Example: summary: Default createConsumer 201 response x-microcks-default: true value: id: abc123 username: example_value custom_id: '500123' tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '409': description: Conflict - a Consumer with the same username or custom_id already exists. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Createconsumer409Example: summary: Default createConsumer 409 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /consumers/{consumer_id_or_username}: parameters: - $ref: '#/components/parameters/ConsumerIdOrUsername' get: operationId: getConsumer summary: Retrieve a Consumer description: Returns details of a specific Consumer by ID or username. tags: - Consumers responses: '200': description: Consumer retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Consumer' examples: Getconsumer200Example: summary: Default getConsumer 200 response x-microcks-default: true value: id: abc123 username: example_value custom_id: '500123' tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Consumer not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getconsumer404Example: summary: Default getConsumer 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateConsumer summary: Update a Consumer description: Updates an existing Consumer entity with partial data. tags: - Consumers requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerInput' examples: UpdateconsumerRequestExample: summary: Default updateConsumer request x-microcks-default: true value: username: example_value custom_id: '500123' tags: - example_value responses: '200': description: Consumer updated successfully. content: application/json: schema: $ref: '#/components/schemas/Consumer' examples: Updateconsumer200Example: summary: Default updateConsumer 200 response x-microcks-default: true value: id: abc123 username: example_value custom_id: '500123' tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Consumer not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Updateconsumer404Example: summary: Default updateConsumer 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: upsertConsumer summary: Create or Update a Consumer description: Inserts or replaces a Consumer by ID or username. tags: - Consumers requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConsumerInput' examples: UpsertconsumerRequestExample: summary: Default upsertConsumer request x-microcks-default: true value: username: example_value custom_id: '500123' tags: - example_value responses: '200': description: Consumer replaced successfully. content: application/json: schema: $ref: '#/components/schemas/Consumer' examples: Upsertconsumer200Example: summary: Default upsertConsumer 200 response x-microcks-default: true value: id: abc123 username: example_value custom_id: '500123' tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '201': description: Consumer created successfully. content: application/json: schema: $ref: '#/components/schemas/Consumer' examples: Upsertconsumer201Example: summary: Default upsertConsumer 201 response x-microcks-default: true value: id: abc123 username: example_value custom_id: '500123' tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteConsumer summary: Delete a Consumer description: Deletes a specific Consumer by ID or username. tags: - Consumers responses: '204': description: Consumer deleted successfully. '404': description: Consumer not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deleteconsumer404Example: summary: Default deleteConsumer 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /consumers/{consumer_id_or_username}/plugins: parameters: - $ref: '#/components/parameters/ConsumerIdOrUsername' get: operationId: listPluginsByConsumer summary: List Plugins Associated With a Consumer description: Returns a paginated list of Plugins associated with a given Consumer. tags: - Plugins parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of plugins for the consumer. content: application/json: schema: $ref: '#/components/schemas/PluginList' examples: Listpluginsbyconsumer200Example: summary: Default listPluginsByConsumer 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title instance_name: example_value config: example_value protocols: {} enabled: true tags: {} ordering: {} service: {} route: {} consumer: {} consumer_group: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createPluginForConsumer summary: Create a Plugin for a Consumer description: Creates a new Plugin associated with the given Consumer. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: CreatepluginforconsumerRequestExample: summary: Default createPluginForConsumer request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '201': description: Plugin created successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Createpluginforconsumer201Example: summary: Default createPluginForConsumer 201 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /plugins: get: operationId: listPlugins summary: List All Plugins description: Returns a paginated list of all installed Plugin configurations. tags: - Plugins parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of plugins. content: application/json: schema: $ref: '#/components/schemas/PluginList' examples: Listplugins200Example: summary: Default listPlugins 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title instance_name: example_value config: example_value protocols: {} enabled: true tags: {} ordering: {} service: {} route: {} consumer: {} consumer_group: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createPlugin summary: Create a New Plugin description: >- Creates a new Plugin instance. A plugin can be applied globally, or scoped to a specific Service, Route, or Consumer. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: CreatepluginRequestExample: summary: Default createPlugin request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '201': description: Plugin created successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Createplugin201Example: summary: Default createPlugin 201 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '409': description: Conflict - a Plugin with the same configuration already exists. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Createplugin409Example: summary: Default createPlugin 409 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /plugins/{plugin_id}: parameters: - $ref: '#/components/parameters/PluginId' get: operationId: getPlugin summary: Retrieve a Plugin description: Returns details of a specific Plugin by ID. tags: - Plugins responses: '200': description: Plugin retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Getplugin200Example: summary: Default getPlugin 200 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Plugin not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getplugin404Example: summary: Default getPlugin 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updatePlugin summary: Update a Plugin description: Updates an existing Plugin entity with partial data. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: UpdatepluginRequestExample: summary: Default updatePlugin request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '200': description: Plugin updated successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Updateplugin200Example: summary: Default updatePlugin 200 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Plugin not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Updateplugin404Example: summary: Default updatePlugin 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: upsertPlugin summary: Create or Update a Plugin description: Inserts or replaces a Plugin by ID. tags: - Plugins requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PluginInput' examples: UpsertpluginRequestExample: summary: Default upsertPlugin request x-microcks-default: true value: name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 responses: '200': description: Plugin replaced successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Upsertplugin200Example: summary: Default upsertPlugin 200 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '201': description: Plugin created successfully. content: application/json: schema: $ref: '#/components/schemas/Plugin' examples: Upsertplugin201Example: summary: Default upsertPlugin 201 response x-microcks-default: true value: id: abc123 name: Example Title instance_name: example_value config: example_value protocols: - http enabled: true tags: - example_value ordering: before: access: - {} after: access: - {} service: id: abc123 route: id: abc123 consumer: id: abc123 consumer_group: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deletePlugin summary: Delete a Plugin description: Deletes a specific Plugin by ID. tags: - Plugins responses: '204': description: Plugin deleted successfully. '404': description: Plugin not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deleteplugin404Example: summary: Default deletePlugin 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /plugins/enabled: get: operationId: listEnabledPlugins summary: List Enabled Plugins description: Returns a list of plugins that are available on the Kong Gateway node. tags: - Plugins responses: '200': description: List of enabled plugin names. content: application/json: schema: type: object properties: enabled_plugins: type: array items: type: string examples: Listenabledplugins200Example: summary: Default listEnabledPlugins 200 response x-microcks-default: true value: enabled_plugins: - example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /upstreams: get: operationId: listUpstreams summary: List All Upstreams description: Returns a paginated list of all Upstream entities. tags: - Upstreams parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of upstreams. content: application/json: schema: $ref: '#/components/schemas/UpstreamList' examples: Listupstreams200Example: summary: Default listUpstreams 200 response x-microcks-default: true value: data: - id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 tags: {} host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createUpstream summary: Create a New Upstream description: Creates a new Upstream entity. tags: - Upstreams requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamInput' examples: CreateupstreamRequestExample: summary: Default createUpstream request x-microcks-default: true value: name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true responses: '201': description: Upstream created successfully. content: application/json: schema: $ref: '#/components/schemas/Upstream' examples: Createupstream201Example: summary: Default createUpstream 201 response x-microcks-default: true value: id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /upstreams/{upstream_id_or_name}: parameters: - $ref: '#/components/parameters/UpstreamIdOrName' get: operationId: getUpstream summary: Retrieve an Upstream description: Returns details of a specific Upstream by ID or name. tags: - Upstreams responses: '200': description: Upstream retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Upstream' examples: Getupstream200Example: summary: Default getUpstream 200 response x-microcks-default: true value: id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Upstream not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getupstream404Example: summary: Default getUpstream 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateUpstream summary: Update an Upstream description: Updates an existing Upstream entity with partial data. tags: - Upstreams requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamInput' examples: UpdateupstreamRequestExample: summary: Default updateUpstream request x-microcks-default: true value: name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true responses: '200': description: Upstream updated successfully. content: application/json: schema: $ref: '#/components/schemas/Upstream' examples: Updateupstream200Example: summary: Default updateUpstream 200 response x-microcks-default: true value: id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Upstream not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Updateupstream404Example: summary: Default updateUpstream 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: upsertUpstream summary: Create or Update an Upstream description: Inserts or replaces an Upstream by ID or name. tags: - Upstreams requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpstreamInput' examples: UpsertupstreamRequestExample: summary: Default upsertUpstream request x-microcks-default: true value: name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true responses: '200': description: Upstream replaced successfully. content: application/json: schema: $ref: '#/components/schemas/Upstream' examples: Upsertupstream200Example: summary: Default upsertUpstream 200 response x-microcks-default: true value: id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '201': description: Upstream created successfully. content: application/json: schema: $ref: '#/components/schemas/Upstream' examples: Upsertupstream201Example: summary: Default upsertUpstream 201 response x-microcks-default: true value: id: abc123 name: Example Title algorithm: round-robin hash_on: none hash_fallback: none hash_on_header: example_value hash_fallback_header: example_value hash_on_cookie: example_value hash_on_cookie_path: example_value hash_on_query_arg: example_value hash_fallback_query_arg: example_value hash_on_uri_capture: example_value hash_fallback_uri_capture: example_value slots: 10 healthchecks: active: type: http timeout: 10 concurrency: 10 http_path: example_value https_verify_certificate: true https_sni: example_value headers: example_value healthy: {} unhealthy: {} passive: type: http healthy: {} unhealthy: {} threshold: 42.5 tags: - example_value host_header: example_value use_srv_name: true created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteUpstream summary: Delete an Upstream description: Deletes a specific Upstream by ID or name. tags: - Upstreams responses: '204': description: Upstream deleted successfully. '404': description: Upstream not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deleteupstream404Example: summary: Default deleteUpstream 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /upstreams/{upstream_id_or_name}/targets: parameters: - $ref: '#/components/parameters/UpstreamIdOrName' get: operationId: listTargetsByUpstream summary: List Targets for an Upstream description: Returns a paginated list of Targets belonging to a given Upstream. tags: - Targets parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of targets for the upstream. content: application/json: schema: $ref: '#/components/schemas/TargetList' examples: Listtargetsbyupstream200Example: summary: Default listTargetsByUpstream 200 response x-microcks-default: true value: data: - id: abc123 target: example_value weight: 10 tags: {} upstream: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createTargetForUpstream summary: Create a Target for an Upstream description: Creates a new Target associated with the given Upstream. tags: - Targets requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TargetInput' examples: CreatetargetforupstreamRequestExample: summary: Default createTargetForUpstream request x-microcks-default: true value: target: example_value weight: 10 tags: - example_value responses: '201': description: Target created successfully. content: application/json: schema: $ref: '#/components/schemas/Target' examples: Createtargetforupstream201Example: summary: Default createTargetForUpstream 201 response x-microcks-default: true value: id: abc123 target: example_value weight: 10 tags: - example_value upstream: id: abc123 created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /upstreams/{upstream_id_or_name}/targets/{target_id_or_target}: parameters: - $ref: '#/components/parameters/UpstreamIdOrName' - name: target_id_or_target in: path required: true description: The unique identifier or target address (host:port) of the Target. schema: type: string delete: operationId: deleteTarget summary: Delete a Target description: Deletes a specific Target from a given Upstream. tags: - Targets responses: '204': description: Target deleted successfully. '404': description: Target not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Deletetarget404Example: summary: Default deleteTarget 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /certificates: get: operationId: listCertificates summary: List All Certificates description: Returns a paginated list of all Certificate entities. tags: - Certificates parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' - $ref: '#/components/parameters/Tags' responses: '200': description: A paginated list of certificates. content: application/json: schema: $ref: '#/components/schemas/CertificateList' examples: Listcertificates200Example: summary: Default listCertificates 200 response x-microcks-default: true value: data: - id: abc123 cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: {} tags: {} created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' next: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createCertificate summary: Create a Certificate description: Creates a new Certificate entity. tags: - Certificates requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CertificateInput' examples: CreatecertificateRequestExample: summary: Default createCertificate request x-microcks-default: true value: cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: - example_value tags: - example_value responses: '201': description: Certificate created successfully. content: application/json: schema: $ref: '#/components/schemas/Certificate' examples: Createcertificate201Example: summary: Default createCertificate 201 response x-microcks-default: true value: id: abc123 cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: - example_value tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK /certificates/{certificate_id}: parameters: - name: certificate_id in: path required: true description: The unique identifier of the Certificate. schema: type: string format: uuid get: operationId: getCertificate summary: Retrieve a Certificate description: Returns details of a specific Certificate by ID. tags: - Certificates responses: '200': description: Certificate retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/Certificate' examples: Getcertificate200Example: summary: Default getCertificate 200 response x-microcks-default: true value: id: abc123 cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: - example_value tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' '404': description: Certificate not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: Getcertificate404Example: summary: Default getCertificate 404 response x-microcks-default: true value: message: example_value name: Example Title code: 10 fields: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: updateCertificate summary: Update a Certificate description: Updates an existing Certificate entity with partial data. tags: - Certificates requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CertificateInput' examples: UpdatecertificateRequestExample: summary: Default updateCertificate request x-microcks-default: true value: cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: - example_value tags: - example_value responses: '200': description: Certificate updated successfully. content: application/json: schema: $ref: '#/components/schemas/Certificate' examples: Updatecertificate200Example: summary: Default updateCertificate 200 response x-microcks-default: true value: id: abc123 cert: example_value key: example_value cert_alt: example_value key_alt: example_value snis: - example_value tags: - example_value created_at: '2026-01-15T10:30:00Z' updated_at: '2026-01-15T10:30:00Z' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteCertificate summary: Delete a Certificate description: Deletes a specific Certificate by ID. tags: - Certificates responses: '204': description: Certificate deleted successfully. x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags: get: operationId: listTags summary: List All Tags description: >- Returns a paginated list of all tags currently used by entities across the Kong Gateway instance. tags: - Tags parameters: - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Size' responses: '200': description: A paginated list of tags. content: application/json: schema: type: object properties: data: type: array items: type: object properties: entity_name: type: string entity_id: type: string tag: type: string offset: type: string examples: Listtags200Example: summary: Default listTags 200 response x-microcks-default: true value: data: - entity_name: example_value entity_id: '500123' tag: example_value offset: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK components: parameters: Offset: name: offset in: query description: Cursor for pagination. Use the offset value from the previous response. required: false schema: type: string Size: name: size in: query description: Number of entities to return per page (max 1000, default 100). required: false schema: type: integer default: 100 minimum: 1 maximum: 1000 Tags: name: tags in: query description: >- A comma-separated list of tags to filter entities by. Use a slash to denote AND (tag1/tag2) or a comma to denote OR (tag1,tag2). required: false schema: type: string ServiceIdOrName: name: service_id_or_name in: path required: true description: The unique identifier (UUID) or name of the Service. schema: type: string RouteIdOrName: name: route_id_or_name in: path required: true description: The unique identifier (UUID) or name of the Route. schema: type: string ConsumerIdOrUsername: name: consumer_id_or_username in: path required: true description: The unique identifier (UUID) or username of the Consumer. schema: type: string PluginId: name: plugin_id in: path required: true description: The unique identifier (UUID) of the Plugin. schema: type: string format: uuid UpstreamIdOrName: name: upstream_id_or_name in: path required: true description: The unique identifier (UUID) or name of the Upstream. schema: type: string schemas: Service: type: object description: >- A Service entity represents an upstream API or microservice that Kong Gateway forwards requests to. properties: id: type: string format: uuid description: The unique identifier of the Service. readOnly: true example: abc123 name: type: string description: An optional human-readable name for the Service. example: Example Title protocol: type: string description: The protocol used to communicate with the upstream. enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss default: http example: http host: type: string description: The host of the upstream server. example: example_value port: type: integer description: The upstream server port. default: 80 minimum: 0 maximum: 65535 example: 10 path: type: string description: The path to be used in requests to the upstream server. example: example_value retries: type: integer description: The number of retries to execute upon failure to proxy. default: 5 example: 10 connect_timeout: type: integer description: >- The timeout in milliseconds for establishing a connection to the upstream server. default: 60000 example: 10 write_timeout: type: integer description: >- The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. default: 60000 example: 10 read_timeout: type: integer description: >- The timeout in milliseconds between two successive read operations for receiving a request from the upstream server. default: 60000 example: 10 url: type: string description: >- Shorthand attribute to set protocol, host, port, and path at once. Write-only convenience field. writeOnly: true example: https://www.example.com tags: type: array description: An optional set of strings for grouping and filtering. items: type: string maxItems: 20 example: [] client_certificate: type: object description: Certificate to be used as client certificate while TLS handshaking to the upstream server. properties: id: type: string format: uuid example: example_value tls_verify: type: boolean description: Whether to enable TLS verification of upstream server certificate. example: true tls_verify_depth: type: integer description: Maximum depth of chain while verifying upstream server TLS certificate. example: 10 ca_certificates: type: array description: Array of CA Certificate object UUIDs used to verify upstream server TLS certificate. items: type: string format: uuid example: [] enabled: type: boolean description: Whether the Service is active. default: true example: true created_at: type: integer description: Unix epoch timestamp of when the entity was created. readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer description: Unix epoch timestamp of when the entity was last updated. readOnly: true example: '2026-01-15T10:30:00Z' required: - host ServiceInput: type: object description: Input schema for creating or updating a Service. properties: name: type: string description: An optional human-readable name for the Service. example: Example Title protocol: type: string enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss default: http example: http host: type: string description: The host of the upstream server. example: example_value port: type: integer default: 80 minimum: 0 maximum: 65535 example: 10 path: type: string example: example_value retries: type: integer default: 5 example: 10 connect_timeout: type: integer default: 60000 example: 10 write_timeout: type: integer default: 60000 example: 10 read_timeout: type: integer default: 60000 example: 10 url: type: string description: >- Shorthand attribute to set protocol, host, port, and path at once. writeOnly: true example: https://www.example.com tags: type: array items: type: string maxItems: 20 example: [] client_certificate: type: object properties: id: type: string format: uuid example: example_value tls_verify: type: boolean example: true tls_verify_depth: type: integer example: 10 ca_certificates: type: array items: type: string format: uuid example: [] enabled: type: boolean default: true example: true ServiceList: type: object description: A paginated list of Service entities. properties: data: type: array items: $ref: '#/components/schemas/Service' example: [] next: type: string description: URI to the next page of results. example: example_value offset: type: string description: Offset token for the next page. example: example_value Route: type: object description: >- A Route defines rules to match client requests. Each Route is associated with a Service, and a Service may have multiple Routes. When a request matches a Route, Kong proxies the request to the associated Service. properties: id: type: string format: uuid description: The unique identifier of the Route. readOnly: true example: abc123 name: type: string description: An optional human-readable name for the Route. example: Example Title protocols: type: array description: An array of the protocols this Route should allow. items: type: string enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss default: - http - https example: [] methods: type: array description: A list of HTTP methods that match this Route. items: type: string enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD - CONNECT - TRACE example: [] hosts: type: array description: A list of domain names that match this Route. items: type: string example: [] paths: type: array description: A list of paths that match this Route. items: type: string example: [] headers: type: object description: >- One or more lists of values indexed by header name that will cause this Route to match if present in the request. additionalProperties: type: array items: type: string example: example_value snis: type: array description: A list of SNIs that match this Route when using stream routing. items: type: string example: [] sources: type: array description: A list of IP sources of incoming connections that match this Route (stream routing). items: type: object properties: ip: type: string port: type: integer example: [] destinations: type: array description: A list of IP destinations of incoming connections that match this Route (stream routing). items: type: object properties: ip: type: string port: type: integer example: [] https_redirect_status_code: type: integer description: The status code Kong responds with when all properties of a Route match except the protocol. default: 426 enum: - 301 - 302 - 307 - 308 - 426 example: 301 regex_priority: type: integer description: A number used to choose which Route resolves a given request when several Routes match it using regexes simultaneously. default: 0 example: 10 strip_path: type: boolean description: When matching a Route via one of the paths, strip the matching prefix from the upstream request URL. default: true example: true path_handling: type: string description: Controls how the Service path, Route path, and requested path are combined when sending a request to the upstream. enum: - v0 - v1 default: v0 example: v0 preserve_host: type: boolean description: When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. default: false example: true request_buffering: type: boolean description: Whether to enable request body buffering. default: true example: true response_buffering: type: boolean description: Whether to enable response body buffering. default: true example: true tags: type: array description: An optional set of strings for grouping and filtering. items: type: string maxItems: 20 example: [] service: type: object description: The Service this Route is associated with. properties: id: type: string format: uuid example: example_value expression: type: string description: The router expression for the Route (expressions router mode). example: example_value priority: type: integer description: The priority of the Route in expressions router mode. default: 0 example: 10 created_at: type: integer description: Unix epoch timestamp of when the entity was created. readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer description: Unix epoch timestamp of when the entity was last updated. readOnly: true example: '2026-01-15T10:30:00Z' RouteInput: type: object description: Input schema for creating or updating a Route. properties: name: type: string example: Example Title protocols: type: array items: type: string enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss default: - http - https example: [] methods: type: array items: type: string example: [] hosts: type: array items: type: string example: [] paths: type: array items: type: string example: [] headers: type: object additionalProperties: type: array items: type: string example: example_value snis: type: array items: type: string example: [] sources: type: array items: type: object properties: ip: type: string port: type: integer example: [] destinations: type: array items: type: object properties: ip: type: string port: type: integer example: [] https_redirect_status_code: type: integer default: 426 example: 10 regex_priority: type: integer default: 0 example: 10 strip_path: type: boolean default: true example: true path_handling: type: string enum: - v0 - v1 default: v0 example: v0 preserve_host: type: boolean default: false example: true request_buffering: type: boolean default: true example: true response_buffering: type: boolean default: true example: true tags: type: array items: type: string maxItems: 20 example: [] service: type: object properties: id: type: string format: uuid example: example_value expression: type: string example: example_value priority: type: integer default: 0 example: 10 RouteList: type: object description: A paginated list of Route entities. properties: data: type: array items: $ref: '#/components/schemas/Route' example: [] next: type: string example: example_value offset: type: string example: example_value Consumer: type: object description: >- A Consumer represents a developer or machine using the API. Consumers are used with authentication plugins to identify and control API access. properties: id: type: string format: uuid description: The unique identifier of the Consumer. readOnly: true example: abc123 username: type: string description: >- The unique username of the Consumer. At least one of username or custom_id must be specified. example: example_value custom_id: type: string description: >- A custom identifier for the Consumer. At least one of username or custom_id must be specified. example: '500123' tags: type: array description: An optional set of strings for grouping and filtering. items: type: string maxItems: 20 example: [] created_at: type: integer description: Unix epoch timestamp of when the entity was created. readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer description: Unix epoch timestamp of when the entity was last updated. readOnly: true example: '2026-01-15T10:30:00Z' ConsumerInput: type: object description: Input schema for creating or updating a Consumer. properties: username: type: string example: example_value custom_id: type: string example: '500123' tags: type: array items: type: string maxItems: 20 example: [] ConsumerList: type: object description: A paginated list of Consumer entities. properties: data: type: array items: $ref: '#/components/schemas/Consumer' example: [] next: type: string example: example_value offset: type: string example: example_value Plugin: type: object description: >- A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins provide extra functionality such as authentication, rate limiting, and transformations. properties: id: type: string format: uuid description: The unique identifier of the Plugin. readOnly: true example: abc123 name: type: string description: The name of the plugin (e.g., rate-limiting, key-auth, cors). example: Example Title instance_name: type: string description: An optional custom name to identify an instance of the plugin. example: example_value config: type: object description: >- The configuration properties for the Plugin which vary depending on the plugin being configured. additionalProperties: true example: example_value protocols: type: array description: A list of the request protocols that will trigger this plugin. items: type: string enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss example: [] enabled: type: boolean description: Whether the plugin is applied. default: true example: true tags: type: array description: An optional set of strings for grouping and filtering. items: type: string maxItems: 20 example: [] ordering: type: object description: >- Describes a dependency to another plugin to determine plugin ordering during the access phase (Enterprise only). properties: before: type: object properties: access: type: array items: type: string after: type: object properties: access: type: array items: type: string example: example_value service: type: object description: If set, the plugin will only activate when receiving requests via the specified Service. properties: id: type: string format: uuid example: example_value route: type: object description: If set, the plugin will only activate when receiving requests via the specified Route. properties: id: type: string format: uuid example: example_value consumer: type: object description: If set, the plugin will activate only for requests where the specified Consumer has been authenticated. properties: id: type: string format: uuid example: example_value consumer_group: type: object description: If set, the plugin will activate only for requests within the specified Consumer Group. properties: id: type: string format: uuid example: example_value created_at: type: integer description: Unix epoch timestamp of when the entity was created. readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer description: Unix epoch timestamp of when the entity was last updated. readOnly: true example: '2026-01-15T10:30:00Z' required: - name PluginInput: type: object description: Input schema for creating or updating a Plugin. properties: name: type: string description: The name of the plugin. example: Example Title instance_name: type: string example: example_value config: type: object additionalProperties: true example: example_value protocols: type: array items: type: string enum: - http - https - grpc - grpcs - tcp - tls - udp - ws - wss example: [] enabled: type: boolean default: true example: true tags: type: array items: type: string maxItems: 20 example: [] ordering: type: object properties: before: type: object properties: access: type: array items: type: string after: type: object properties: access: type: array items: type: string example: example_value service: type: object properties: id: type: string format: uuid example: example_value route: type: object properties: id: type: string format: uuid example: example_value consumer: type: object properties: id: type: string format: uuid example: example_value consumer_group: type: object properties: id: type: string format: uuid example: example_value required: - name PluginList: type: object description: A paginated list of Plugin entities. properties: data: type: array items: $ref: '#/components/schemas/Plugin' example: [] next: type: string example: example_value offset: type: string example: example_value Upstream: type: object description: >- An Upstream object represents a virtual hostname and can be used to health-check, circuit-break, and load-balance incoming requests over multiple services. properties: id: type: string format: uuid readOnly: true example: abc123 name: type: string description: A hostname which must be equal to the host of a Service. example: Example Title algorithm: type: string description: The load balancing algorithm to use. enum: - round-robin - consistent-hashing - least-connections - latency default: round-robin example: round-robin hash_on: type: string description: What to use as hashing input when the consistent-hashing algorithm is selected. enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture default: none example: none hash_fallback: type: string description: What to use as hashing input if the primary hash_on does not return a hash. enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture default: none example: none hash_on_header: type: string description: The header name to take the value from as hash input (when hash_on is set to header). example: example_value hash_fallback_header: type: string example: example_value hash_on_cookie: type: string example: example_value hash_on_cookie_path: type: string default: / example: example_value hash_on_query_arg: type: string example: example_value hash_fallback_query_arg: type: string example: example_value hash_on_uri_capture: type: string example: example_value hash_fallback_uri_capture: type: string example: example_value slots: type: integer description: The number of slots in the load balancer algorithm. default: 10000 minimum: 10 maximum: 65536 example: 10 healthchecks: $ref: '#/components/schemas/Healthchecks' tags: type: array items: type: string maxItems: 20 example: [] host_header: type: string description: The hostname to be used as Host header when proxying requests through ring-balancer. example: example_value use_srv_name: type: boolean description: If set, balancer will use SRV hostname as the proxy Host header. default: false example: true created_at: type: integer readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer readOnly: true example: '2026-01-15T10:30:00Z' required: - name UpstreamInput: type: object properties: name: type: string example: Example Title algorithm: type: string enum: - round-robin - consistent-hashing - least-connections - latency default: round-robin example: round-robin hash_on: type: string enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture default: none example: none hash_fallback: type: string enum: - none - consumer - ip - header - cookie - path - query_arg - uri_capture default: none example: none hash_on_header: type: string example: example_value hash_fallback_header: type: string example: example_value hash_on_cookie: type: string example: example_value hash_on_cookie_path: type: string default: / example: example_value hash_on_query_arg: type: string example: example_value hash_fallback_query_arg: type: string example: example_value hash_on_uri_capture: type: string example: example_value hash_fallback_uri_capture: type: string example: example_value slots: type: integer default: 10000 minimum: 10 maximum: 65536 example: 10 healthchecks: $ref: '#/components/schemas/Healthchecks' tags: type: array items: type: string maxItems: 20 example: [] host_header: type: string example: example_value use_srv_name: type: boolean default: false example: true required: - name UpstreamList: type: object properties: data: type: array items: $ref: '#/components/schemas/Upstream' example: [] next: type: string example: example_value offset: type: string example: example_value Healthchecks: type: object description: Health check configuration for an upstream. properties: active: type: object properties: type: type: string enum: - http - https - tcp default: http timeout: type: integer default: 1 concurrency: type: integer default: 10 http_path: type: string default: / https_verify_certificate: type: boolean default: true https_sni: type: string headers: type: object additionalProperties: type: array items: type: string healthy: type: object properties: interval: type: integer default: 0 http_statuses: type: array items: type: integer default: [200, 302] successes: type: integer default: 0 unhealthy: type: object properties: interval: type: integer default: 0 http_statuses: type: array items: type: integer default: [429, 404, 500, 501, 502, 503, 504, 505] tcp_failures: type: integer default: 0 timeouts: type: integer default: 0 http_failures: type: integer default: 0 example: example_value passive: type: object properties: type: type: string enum: - http - https - tcp default: http healthy: type: object properties: http_statuses: type: array items: type: integer default: [200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 306, 307, 308] successes: type: integer default: 0 unhealthy: type: object properties: http_statuses: type: array items: type: integer default: [429, 500, 503] tcp_failures: type: integer default: 0 timeouts: type: integer default: 0 http_failures: type: integer default: 0 example: example_value threshold: type: number default: 0 example: 42.5 Target: type: object description: >- A Target is an IP address/hostname with a port that identifies an instance of a backend service. properties: id: type: string format: uuid readOnly: true example: abc123 target: type: string description: The target address (IP or hostname) and port (host:port). example: example_value weight: type: integer description: The weight this target gets within the upstream (0-65535). 0 means the target is disabled. default: 100 minimum: 0 maximum: 65535 example: 10 tags: type: array items: type: string maxItems: 20 example: [] upstream: type: object properties: id: type: string format: uuid example: example_value created_at: type: number readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: number readOnly: true example: '2026-01-15T10:30:00Z' required: - target TargetInput: type: object properties: target: type: string description: The target address (IP or hostname) and port. example: example_value weight: type: integer default: 100 minimum: 0 maximum: 65535 example: 10 tags: type: array items: type: string maxItems: 20 example: [] required: - target TargetList: type: object properties: data: type: array items: $ref: '#/components/schemas/Target' example: [] next: type: string example: example_value offset: type: string example: example_value Certificate: type: object description: A Certificate object represents a public certificate for TLS termination. properties: id: type: string format: uuid readOnly: true example: abc123 cert: type: string description: PEM-encoded public certificate chain. example: example_value key: type: string description: PEM-encoded private key of the certificate. example: example_value cert_alt: type: string description: PEM-encoded public certificate chain of the alternate certificate. example: example_value key_alt: type: string description: PEM-encoded private key of the alternate certificate. example: example_value snis: type: array description: The list of SNI hostnames associated with this certificate. items: type: string example: [] tags: type: array items: type: string maxItems: 20 example: [] created_at: type: integer readOnly: true example: '2026-01-15T10:30:00Z' updated_at: type: integer readOnly: true example: '2026-01-15T10:30:00Z' required: - cert - key CertificateInput: type: object properties: cert: type: string example: example_value key: type: string example: example_value cert_alt: type: string example: example_value key_alt: type: string example: example_value snis: type: array items: type: string example: [] tags: type: array items: type: string maxItems: 20 example: [] required: - cert - key CertificateList: type: object properties: data: type: array items: $ref: '#/components/schemas/Certificate' example: [] next: type: string example: example_value offset: type: string example: example_value NodeInfo: type: object description: General details about the Kong Gateway node. properties: version: type: string description: The version of the Kong Gateway instance. example: example_value lua_version: type: string description: The version of the Lua runtime. example: example_value tagline: type: string example: example_value hostname: type: string example: example_value node_id: type: string format: uuid example: '500123' timers: type: object properties: pending: type: integer running: type: integer example: example_value plugins: type: object properties: available_on_server: type: object additionalProperties: type: boolean enabled_in_cluster: type: array items: type: string example: example_value configuration: type: object additionalProperties: true example: example_value NodeStatus: type: object description: Status information about the Kong Gateway node. properties: database: type: object properties: reachable: type: boolean example: example_value memory: type: object properties: workers_lua_vms: type: array items: type: object properties: http_allocated_gc: type: string pid: type: integer lua_shared_dicts: type: object additionalProperties: type: object properties: allocated_slabs: type: string capacity: type: string example: example_value server: type: object properties: connections_accepted: type: integer connections_active: type: integer connections_handled: type: integer connections_reading: type: integer connections_waiting: type: integer connections_writing: type: integer total_requests: type: integer example: example_value configuration_hash: type: string example: example_value Error: type: object description: Standard error response from the Admin API. properties: message: type: string description: A human-readable error message. example: example_value name: type: string description: The error type name. example: Example Title code: type: integer description: An optional error code. example: 10 fields: type: object description: Field-level validation errors. additionalProperties: true example: example_value