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 Transit Gateways API

The Transit Gateways API from Kong — 2 operation(s) for transit gateways.

Kong Transit Gateways 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 Transit Gateways. 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 56 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 56 schemas 1 DELETE2 GET1 PATCH1 POST

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 Transit Gateways 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 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Transit Gateways 5
GET
/v2/cloud-gateways/networks/{networkId}/transit-gateways
List Transit Gateways
list-transit-gateways 4 params → 200400401403404
POST
/v2/cloud-gateways/networks/{networkId}/transit-gateways
Create Transit Gateway
create-transit-gateway 1 param body → 201400401403404409
GET
/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}
Get Transit Gateway
get-transit-gateway 2 params → 200401403404
PATCH
/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}
Update Transit Gateway
update-transit-gateway 2 params body → 200400401403404409
DELETE
/v2/cloud-gateways/networks/{networkId}/transit-gateways/{transitGatewayId}
Delete Transit Gateway
delete-transit-gateway 2 params → 204400401403404

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are AwsTransitGatewayResponse (10 properties), AwsVpcPeeringGatewayResponse (10 properties), AwsResourceEndpointGatewayResponse (9 properties), AzureVHubPeeringGatewayResponse (9 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
CreateAzureVHubPeeringGateway
object
3 properties 2 required
CreateGCPVPCPeeringTransitGateway
object
3 properties 2 required
GCPVPCPeeringAttachmentConfig
object
3 properties 3 required
AwsResourceEndpointAttachmentConfig
object
3 properties 2 required
TransitGatewayStateFieldNotEqualsFilter
object
Filter transit-gateway state by inequality match.
1 property 1 required
AwsResourceEndpointConfig
array
List of unique resource config mapping for aws resource endpoint.
AwsVpcPeeringGatewayResponse
object
10 properties 9 required
ConflictError
PatchTransitGatewayRequest
object
Request schema for updating a transit gateway.
CreateAwsResourceEndpointGateway
object
3 properties 2 required
TransitGatewayStateFieldFilter
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterChoiceItem
object
5 properties 4 required
AzureTransitGatewayResponse
object
9 properties 8 required
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
AzureVHubPeeringGatewayResponse
object
9 properties 8 required
CreateTransitGatewayRequest
object
Request schema for creating a transit gateway.
AwsResourceEndpointConfigState
string
The current state of the resource config in AWS Resource Endpoint. Possible values: - initializing - The config is in the process of being initialized and is s…
AwsTransitGatewayAttachmentConfig
object
3 properties 3 required
ForbiddenError
UnauthorizedError
AwsTransitGatewayResponse
object
10 properties 9 required
CreateAwsTransitGateway
object
4 properties 3 required
TransitGatewaysFilterParameters
object
2 properties
GCPVPCPeeringGatewayResponse
object
9 properties 8 required
PatchAwsTransitGateway
object
Request schema for updating AWS Transit Gateway
1 property 1 required
TransitGatewayName
string
Human-readable name of the transit gateway.
AzureVHubPeeringAttachmentConfig
object
5 properties 5 required
AwsResourceEndpointGatewayResponse
object
9 properties 8 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
AwsVpcPeeringGatewayAttachmentConfigForResponse
object
5 properties 4 required
TransitGatewayDnsConfig
array
List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway attachment.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
BadRequestError
InvalidParameters
array
invalid parameters
AwsResourceEndpointAttachmentConfigResponse
object
3 properties 3 required
TransitGatewayResponse
TransitGatewayState
string
The current state of the Transit Gateway. Possible values: - created - The attachment has been created but is not attached to transit gateway. - initializing -…
AwsResourceEndpointConfigResponse
array
List of unique resource config mapping for aws resource endpoint.
AwsVpcPeeringGatewayAttachmentConfig
object
4 properties 4 required
TransitGatewayStateFieldEqualsFilter
Filter transit-gateway state by exact match.
InvalidParameterStandard
object
4 properties 2 required
CreateAwsVpcPeeringGateway
object
4 properties 3 required
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
TransitGatewayId
string
TransitGatewayStateFieldOrEqualityFilter
object
Filter transit-gateway state by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.
1 property 1 required
AwsTransitGatewayAttachmentConfigForResponse
object
4 properties 3 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
AzureVNETPeeringAttachmentConfig
object
5 properties 5 required
CreateAzureTransitGateway
object
3 properties 2 required
TransitGatewayCIDRBlocks
array
CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning network.
PatchAwsResourceEndpointGateway
object
Request schema for updating AWS Resource Endpoint.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-transit-gateways-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