The Kong Konnect Platform API is the unified programmatic surface for the Konnect SaaS control plane. It exposes control planes, API products, developer portals, service catalog, identity and team management, analytics dashboards, audit logging, dedicated cloud gateways, CMEK, Event Gateway configuration, MCP Registry, Mesh Manager, metering & billing, notification hub, and search across the platform — over 20 individual API surfaces under one OpenAPI 3.1 document.
openapi: 3.1.0
info:
title: Konnect API - Go SDK
version: 3.14.0
description: The Konnect platform API
contact:
name: Kong Inc
url: 'https://konghq.com'
email: [email protected]
x-extensions-note: |
This API uses the `x-expression` vendor extension to indicate that a string property is a DSL expression.
Supported types:
- `boolean`: An expression evaluates to boolean. For example, `context.topic.name == 'my-topic'`
- `string`: A template string expression that evaluates to a string or a literal string value. For example,
`${context.topic.name.substring(0, context.topic.name.length-4)}` or `my-literal-value`
Additionally, `x-sensitive` flag indicates that a field contains sensitive information. When the value
of the field is provided in plain text, it's encrypted at rest and it's never returned in API responses.
When the value is an expression, the expression itself is stored and returned in API responses.
`x-min-runtime-version` indicates the minimum Event Gateway runtime version required to use a certain policy or
policy feature. The runtime version can be configured at the Event Gateway entity level. It must be a string
containing a semantic version in the `MAJOR.MINOR` format, e.g., `"1.1"`.
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
x-oas-source: kong/platform-api@
x-oas-source-link: 'https://github.com/Kong/platform-api/commit/'
servers:
- url: 'https://global.api.konghq.com'
- url: 'https://us.api.konghq.com'
- url: 'https://eu.api.konghq.com'
- url: 'https://au.api.konghq.com'
paths:
'/v1/apis/{apiId}/service-mappings':
parameters:
- name: apiId
in: path
description: ID of the API.
required: true
schema:
type: string
format: uuid
get:
operationId: list-service-mappings-for-api
summary: List Service Mappings for an API
description: Returns a paginated collection of Service mappings for the given API.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/CatalogServiceApiMappingSort'
- $ref: '#/components/parameters/CatalogApiServiceMappingFilter'
responses:
'200':
$ref: '#/components/responses/ListCatalogServiceApiMappingsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Service API Mappings
/v1/catalog-services:
post:
x-speakeasy-entity-operation: CatalogService#create
operationId: create-catalog-service
summary: Create Service
description: Creates a service.
requestBody:
$ref: '#/components/requestBodies/CreateCatalogServiceRequest'
responses:
'201':
$ref: '#/components/responses/CatalogServiceResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Catalog Services
get:
operationId: list-catalog-services
summary: List Services
description: Returns a paginated collection of services.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/CatalogServiceFilter'
- $ref: '#/components/parameters/CatalogServiceSort'
responses:
'200':
$ref: '#/components/responses/ListCatalogServicesResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Catalog Services
'/v1/catalog-services/{id}':
parameters:
- name: id
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
get:
x-speakeasy-entity-operation:
terraform-resource: CatalogService#read
terraform-datasource: null
operationId: fetch-catalog-service
summary: Get a Service
description: Fetches a service.
responses:
'200':
$ref: '#/components/responses/CatalogServiceResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Services
patch:
x-speakeasy-entity-operation: CatalogService#update
operationId: update-catalog-service
summary: Update Service
description: Updates a service.
requestBody:
$ref: '#/components/requestBodies/UpdateCatalogServiceRequest'
responses:
'200':
$ref: '#/components/responses/CatalogServiceResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- Catalog Services
delete:
x-speakeasy-entity-operation: CatalogService#delete
operationId: delete-catalog-service
summary: Delete Service
description: Deletes a service.
responses:
'204':
description: Service was deleted successfully.
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Services
'/v1/catalog-services/{id}/resources':
parameters:
- name: id
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
get:
operationId: list-catalog-service-resources
summary: List Service Resources
description: Returns a paginated collection of resources mapped to a service.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/CatalogResourceRefFilter'
responses:
'200':
$ref: '#/components/responses/ListCatalogServiceResourcesResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Service Resources
'/v1/catalog-services/{id}/scorecards':
parameters:
- name: id
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
get:
operationId: list-catalog-service-scorecards
summary: List Catalog Service Scorecards
description: Returns a paginated collection of scorecards targeting the given service.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/ScorecardFilter'
- $ref: '#/components/parameters/ScorecardSort'
responses:
'200':
$ref: '#/components/responses/ListCatalogServiceScorecardsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Scorecards
'/v1/catalog-services/{serviceId}/api-mappings':
parameters:
- name: serviceId
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
get:
operationId: list-catalog-service-api-mappings
summary: List API Mappings for a Service
description: Returns a paginated collection of API mappings for the given service.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/CatalogServiceApiMappingSort'
- $ref: '#/components/parameters/CatalogServiceApiMappingFilter'
responses:
'200':
$ref: '#/components/responses/ListCatalogServiceApiMappingsResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Service API Mappings
post:
operationId: create-catalog-service-api-mapping
summary: Create API Mapping for a Service
description: Creates a new API mapping for the given service.
requestBody:
$ref: '#/components/requestBodies/CreateCatalogServiceApiMappingBody'
responses:
'201':
$ref: '#/components/responses/CatalogServiceApiMappingResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
tags:
- Catalog Service API Mappings
'/v1/catalog-services/{serviceId}/api-mappings/{mappingId}':
parameters:
- name: serviceId
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
- name: mappingId
in: path
description: ID of the catalog service API mapping.
required: true
schema:
type: string
format: uuid
example: d277faad-ed4e-4c56-a0fb-acce065dee34
get:
operationId: get-catalog-service-api-mapping
summary: Get API Mapping for a Service
description: Returns information about a specific API mapping for the given service.
responses:
'200':
$ref: '#/components/responses/CatalogServiceApiMappingResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Service API Mappings
delete:
operationId: delete-catalog-service-api-mapping
summary: Delete API Mapping for a Service
description: Deletes a specific API mapping for the given service.
responses:
'204':
description: Catalog service API mapping was deleted successfully.
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Catalog Service API Mappings
'/v1/catalog-services/{serviceId}/scorecards/{scorecardId}':
parameters:
- name: serviceId
in: path
description: The `id` of the service.
required: true
schema:
type: string
example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
- name: scorecardId
in: path
description: The `id` of the scorecard.
required: true
schema:
type: string
format: uuid
example: f3704e4c-104d-4f21-998a-20d4364c893f
get:
operationId: fetch-catalog-service-scorecard
summary: Get a Catalog Service Scorecard
description: Fetches the given scorecard targeting the service.
responses:
'200':
$ref: '#/components/responses/CatalogServiceScorecardResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Scorecards
/v1/criteria-templates:
get:
operationId: list-criteria-templates
summary: List Criteria Templates
description: Returns a paginated collection of criteria templates.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageNumber'
- $ref: '#/components/parameters/CriteriaTemplateFilter'
- $ref: '#/components/parameters/CriteriaTemplateSort'
responses:
'200':
$ref: '#/components/responses/ListCriteriaTemplatesResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Criteria Templates
/v1/event-gateways:
get:
operationId: list-event-gateways
summary: List all Event Gateways
description: Returns an array of gateway objects containing information about the Konnect Event Gateways.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageAfter'
- $ref: '#/components/parameters/EventGatewayCommonFilter'
responses:
'200':
$ref: '#/components/responses/ListEventGatewaysResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/Internal'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- Event Gateways
post:
x-speakeasy-entity-operation:
terraform-resource: EventGateway#create
terraform-datasource: null
operationId: create-event-gateway
summary: Create Event Gateway
description: Create a Event gateway in the Konnect Organization.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGatewayRequest'
responses:
'201':
$ref: '#/components/responses/CreateGatewayResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
$ref: '#/components/responses/Conflict'
'500':
$ref: '#/components/responses/Internal'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- Event Gateways
'/v1/event-gateways/{gatewayId}':
parameters:
- name: gatewayId
in: path
description: The UUID of your Gateway.
required: true
schema:
type: string
format: uuid
example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
x-speakeasy-match: id
get:
x-speakeasy-entity-operation:
terraform-resource: EventGateway#read
terraform-datasource: null
operationId: get-event-gateway
summary: Get an Event Gateway
description: Returns information about an individual Event gateway.
responses:
'200':
description: A response to retrieving a single eventgateway.
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayInfo'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/Internal'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- Event Gateways
put:
x-speakeasy-entity-operation:
terraform-resource: EventGateway#update
terraform-datasource: null
operationId: update-event-gateway
summary: Update Event Gateway
description: Update an individual gateway.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGatewayRequest'
responses:
'200':
$ref: '#/components/responses/UpdateGatewayResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/Internal'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- Event Gateways
patch:
operationId: patch-event-gateway
summary: Partially Update Event Gateway
description: Patch an individual gateway.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchGatewayRequest'
responses:
'200':
$ref: '#/components/responses/UpdateGatewayResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/Internal'
'503':
$ref: '#/components/responses/NotAvailable'
tags:
- Event Gateways
delete:
x-speakeasy-entity-operation:
terraform-resource: EventGateway#delete
terraform-datasource: null
operationId: delete-event-gateway
summary: Delete Event Gateway
description: Delete an individual gateway.
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateways
'/v1/event-gateways/{gatewayId}/backend-clusters':
parameters:
- $ref: '#/components/parameters/gatewayId'
get:
operationId: list-event-gateway-backend-clusters
summary: List Backend Clusters
description: Returns a list of backend clusters associated with the specified Event Gateway.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageAfter'
- $ref: '#/components/parameters/EventGatewayCommonFilter'
responses:
'200':
$ref: '#/components/responses/ListBackendClustersResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Backend Clusters
post:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayBackendCluster#create
terraform-datasource: null
operationId: create-event-gateway-backend-cluster
summary: Create Backend Cluster
description: Creates a new backend cluster.
requestBody:
$ref: '#/components/requestBodies/CreateBackendClusterRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/BackendCluster'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Backend Clusters
'/v1/event-gateways/{gatewayId}/backend-clusters/{backendClusterId}':
parameters:
- $ref: '#/components/parameters/gatewayId'
- name: backendClusterId
in: path
description: The ID of the Backend Cluster.
required: true
schema:
type: string
format: uuid
x-speakeasy-match: id
get:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayBackendCluster#read
terraform-datasource: null
operationId: get-event-gateway-backend-cluster
summary: Get a Backend Cluster
description: Returns information about a specific backend cluster.
responses:
'200':
description: A single backend cluster object.
content:
application/json:
schema:
$ref: '#/components/schemas/BackendCluster'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway Backend Clusters
put:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayBackendCluster#update
terraform-datasource: null
operationId: update-event-gateway-backend-cluster
summary: Update Backend Cluster
description: Updates an existing backend cluster.
requestBody:
$ref: '#/components/requestBodies/UpdateBackendClusterRequest'
responses:
'200':
description: Updated backend cluster object.
content:
application/json:
schema:
$ref: '#/components/schemas/BackendCluster'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Backend Clusters
delete:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayBackendCluster#delete
terraform-datasource: null
operationId: delete-event-gateway-backend-cluster
summary: Delete Backend Cluster
description: Deletes a specific backend cluster.
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway Backend Clusters
'/v1/event-gateways/{gatewayId}/data-plane-certificates':
parameters:
- $ref: '#/components/parameters/gatewayId'
get:
operationId: list-event-gateway-data-plane-certificates
summary: List Event Gateway DataPlane Certificates
description: Returns a list of dataplane certificates that are associated to this event gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this event gateway.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageAfter'
- $ref: '#/components/parameters/EventGatewayCommonFilter'
responses:
'200':
$ref: '#/components/responses/ListEventGatewayDataPlaneCertificatesResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway DataPlane Certificates
post:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayDataPlaneCertificate#create
terraform-datasource: null
operationId: create-event-gateway-data-plane-certificate
summary: Create a New DataPlane Certificate
description: Create new dataplane certificate to this event gateway. A dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this event gateway.
requestBody:
$ref: '#/components/requestBodies/CreateEventGatewayDataPlaneCertificateRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayDataPlaneCertificate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway DataPlane Certificates
'/v1/event-gateways/{gatewayId}/data-plane-certificates/{certificateId}':
parameters:
- $ref: '#/components/parameters/gatewayId'
- name: certificateId
in: path
description: The ID of the dataplane certificate.
required: true
schema:
type: string
format: uuid
x-speakeasy-match: id
get:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayDataPlaneCertificate#read
terraform-datasource: null
operationId: get-event-gateway-data-plane-certificate
summary: Get a DataPlane Certificate
description: Returns information about an individual dataplane certificate.
responses:
'200':
description: A single dataplane certificate.
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayDataPlaneCertificate'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway DataPlane Certificates
put:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayDataPlaneCertificate#update
terraform-datasource: null
operationId: update-event-gateway-data-plane-certificate
summary: Update Event Gateway DataPlane Certificate
description: Updates an existing dataplane certificate associated with the specified Event Gateway.
requestBody:
$ref: '#/components/requestBodies/UpdateEventGatewayDataPlaneCertificateRequest'
responses:
'200':
description: Updated event gateway dataplane certificate object.
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayDataPlaneCertificate'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway DataPlane Certificates
delete:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayDataPlaneCertificate#delete
terraform-datasource: null
operationId: delete-event-gateway-data-plane-certificate
summary: Delete Event Gateway DataPlane Certificate
description: Deletes a specific dataplane certificate associated with the Event Gateway.
responses:
'204':
description: No Content
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway DataPlane Certificates
'/v1/event-gateways/{gatewayId}/listeners':
parameters:
- $ref: '#/components/parameters/gatewayId'
get:
operationId: list-event-gateway-listeners
summary: List Event Gateway Listeners
description: Returns a list of listeners associated with the specified Event Gateway.
parameters:
- $ref: '#/components/parameters/PageSize'
- $ref: '#/components/parameters/PageAfter'
- $ref: '#/components/parameters/EventGatewayListenersFilter'
responses:
'200':
$ref: '#/components/responses/ListEventGatewayListenersResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Listeners
post:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayListener#create
terraform-datasource: null
operationId: create-event-gateway-listener
summary: Create Event Gateway Listener
description: Creates a new listener associated with the specified Event Gateway.
requestBody:
$ref: '#/components/requestBodies/CreateEventGatewayListenerRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayListener'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Listeners
'/v1/event-gateways/{gatewayId}/listeners/{eventGatewayListenerId}':
parameters:
- $ref: '#/components/parameters/gatewayId'
- name: eventGatewayListenerId
in: path
description: The ID of the Event Gateway Listener.
required: true
schema:
type: string
format: uuid
x-speakeasy-match: id
get:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayListener#read
terraform-datasource: null
operationId: get-event-gateway-listener
summary: Get an Event Gateway Listener
description: Returns information about a specific listener associated with the Event Gateway.
responses:
'200':
description: A single event gateway listener object.
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayListener'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
tags:
- Event Gateway Listeners
put:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayListener#update
terraform-datasource: null
operationId: update-event-gateway-listener
summary: Update Event Gateway Listener
description: Updates an existing listener associated with the specified Event Gateway.
requestBody:
$ref: '#/components/requestBodies/UpdateEventGatewayListenerRequest'
responses:
'200':
description: Updated event gateway listener object.
content:
application/json:
schema:
$ref: '#/components/schemas/EventGatewayListener'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
tags:
- Event Gateway Listeners
delete:
x-speakeasy-entity-operation:
terraform-resource: EventGatewayListener#delete
terraform-datasource: null
operationId: delete-event-gateway-listener
summary: Delete Event Gateway Listener
description: Deletes a specific listener associated with t
# --- truncated at 32 KB (1852 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kong/refs/heads/main/openapi/kong-konnect-platform-api.yml