Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Event Gateway Schema Registries API

Configure a schema registry that can be used to validate payloads when producing/consuming messages

Kong Event Gateway Schema Registries API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Event Gateway Schema Registries. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 31 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

5 operations 2 paths 31 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Event Gateway Schema Registries API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Event Gateway Schema Registries 5

Configure a schema registry that can be used to validate payloads when producing/consuming messages

GET
/v1/event-gateways/{gatewayId}/schema-registries
List Schema Registries
list-event-gateway-schema-registries 4 params → 200401403
POST
/v1/event-gateways/{gatewayId}/schema-registries
Create Schema Registry
create-event-gateway-schema-registry 1 param body → 201400401403
GET
/v1/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
Get a Schema Registry
get-event-gateway-schema-registry 2 params → 200401403404
PUT
/v1/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
Update Schema Registry
update-event-gateway-schema-registry 2 params body → 200400401403
DELETE
/v1/event-gateways/{gatewayId}/schema-registries/{schemaRegistryId}
Delete Schema Registry
delete-event-gateway-schema-registry 2 params → 204400401403404

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SchemaRegistry (8 properties), SchemaRegistryConfluentSensitiveDataAware (5 properties), BaseError (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
SchemaRegistryAuthenticationBasicSensitiveDataAware
object
3 properties 2 required
SchemaRegistryAuthenticationBasic
object
Basic authentication scheme for the schema registry with username and password.
3 properties 3 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
SchemaRegistry
object
A schema registry that contains schemas.
8 properties 5 required
SchemaRegistryCreate
The typed schema of the schema registry to create it.
GatewaySecretReferenceOrLiteral
string
A literal value or a reference to an existing secret as a template string expression. The value is stored and returned by the API as-is, not treated as sensiti…
SchemaRegistryAuthenticationScheme
The authentication configuration for the schema registry.
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
SchemaRegistryConfluent
object
A Confluent schema registry.
5 properties 3 required
ForbiddenError
CursorMetaPage
object
5 properties 3 required
UnauthorizedError
CursorMeta
object
Pagination metadata.
1 property 1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
GatewaySecret
string
A sensitive value containing the secret or a reference to a secret as a template string expression. If the value is provided as plain text, it is encrypted at…
SchemaRegistryConfluentConfig
object
The configuration of [Confluent Schema Registry](https://github.com/confluentinc/schema-registry)
4 properties 2 required
SchemaRegistryAuthenticationSensitiveDataAwareScheme
The authentication configuration for the schema registry.
SchemaRegistryUpdate
The typed schema of the schema registry to modify it.
SchemaRegistryConfluentConfigSensitiveDataAware
object
The configuration of [Confluent Schema Registry](https://github.com/confluentinc/schema-registry)
4 properties 2 required
NotFoundError
SchemaRegistryConfluentSensitiveDataAware
object
A Confluent schema registry.
5 properties 3 required
StringFieldContainsFilter
object
Filters on the given string field value by fuzzy match.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-event-gateway-schema-registries-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API