How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Networks API

The Networks API from Kong — 3 operation(s) for networks.

Kong Networks 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 Networks. 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 6 operations across 3 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

6 operations 3 paths 49 schemas 1 DELETE3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Networks API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 6

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

Networks 6
GET
/v2/cloud-gateways/networks
List Networks
list-networks 3 params → 200400401403
POST
/v2/cloud-gateways/networks
Create Network
create-network body → 201400401403409
GET
/v2/cloud-gateways/networks/{networkId}
Get Network
get-network 1 param → 200401403404
PATCH
/v2/cloud-gateways/networks/{networkId}
Update Network
update-network 1 param body → 200400401403404409
DELETE
/v2/cloud-gateways/networks/{networkId}
Delete Network
delete-network 1 param → 204400401403404
GET
/v2/cloud-gateways/networks/{networkId}/configuration-references
List Network Configuration References
list-network-configurations 3 params → 200400401403404

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Network (15 properties), ConfigurationDataPlaneGroup (12 properties), ConfigurationManifest (11 properties), CreateNetworkRequest (6 properties). Each schema is shown below with its type and property counts.

BaseError
object
standard error
5 properties 4 required
BadRequestError
InvalidParameterMinimumLength
object
5 properties 4 required
ConfigurationId
string
ConfigurationDataPlaneGroupAutoscaleAutopilot
object
Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.
3 properties 2 required
NetworkProviderMetadata
object
Metadata describing attributes returned by cloud-provider for the network.
2 properties
PaginatedMeta
object
returns the pagination information
1 property 1 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
ConfigurationKind
string
Pre-release Feature This feature is currently in beta and is subject to change. Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the follow…
NetworkStateMetadata
object
Metadata describing the backing state of the network and why it may be in an erroneous state.
2 properties
UnauthorizedError
NotFoundError
NetworkName
string
Human-readable name of the network.
ConfigurationDataPlaneGroupAutoscale
ConfigurationManifest
object
Object containing information about a control-plane's cloud-gateways configuration.
11 properties 8 required
NetworkStateFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
ProviderAccountId
string
InstanceTypeName
string
Instance type name to indicate capacity.
CreateNetworkRequest
object
Request schema for creating a network.
6 properties 5 required
DataPlaneGroupId
string
ID of the data-plane group that represents a deployment target for a set of data-planes.
NetworkCreateState
string
Initial state for creating a network.
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
InvalidRules
string
invalid parameters rules
NetworkCIDRBlock
string
CIDR block configuration for the network.
ConfigurationDataPlaneGroupConfig
object
Object that describes where a data-plane group will be deployed to, along with how many instances.
5 properties 2 required
ConfigurationDataPlaneGroupAutoscaleStatic
object
Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a futur…
3 properties 3 required
PatchNetworkRequest
object
Request schema for updating a network.
1 property
InvalidParameterChoiceItem
object
5 properties 4 required
ConfigurationDataPlaneGroupEnvironmentField
object
Environment variable name and value to set for a data-plane group.
2 properties 2 required
NetworkAvailabilityZones
array
List of availability zones that the network is attached to.
NetworkConfigurationReference
InvalidParameters
array
invalid parameters
Network
object
Object containing information about a network to be used in configurations.
15 properties 14 required
ApiAccess
string
Type of API access data-plane groups will support for a configuration.
NetworksFilterParameters
object
2 properties
ForbiddenError
ConflictError
ProviderName
string
Name of cloud provider.
GatewayVersion
string
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
ProviderRegionId
string
Region ID for cloud provider region.
InvalidParameterDependentItem
object
5 properties 4 required
NetworkState
State of the network.
ConfigurationDataPlaneGroup
object
Object that describes the set of data-plane groups currently pointed to this configuration.
12 properties 6 required
ControlPlaneId
string
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
ConfigurationDataPlaneGroupEnvironment
array
Array of environment variables to set for a data-plane group.
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-networks-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
Where this information came from

This is an independent, third-party profile of Kong Networks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.