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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
6 operations3 paths49 schemas1 DELETE3 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Kong Networks 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 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.
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.
InvalidParameterMinimumLength
object
5 properties4 required
NetworkProviderMetadata
object
Metadata describing attributes returned by cloud-provider for the network.
2 properties
ConfigurationDataPlaneGroupAutoscaleAutopilot
object
Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.
3 properties2 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
ConfigurationId
string
ControlPlaneId
string
NetworkConfigurationReference
ConflictError
InvalidParameterChoiceItem
object
5 properties4 required
ConfigurationDataPlaneGroupConfig
object
Object that describes where a data-plane group will be deployed to, along with how many instances.
5 properties2 required
InvalidParameterMaximumLength
object
5 properties4 required
NetworkCreateState
string
Initial state for creating a network.
NetworkState
State of the network.
GatewayVersion
string
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
ConfigurationManifest
object
Object containing information about a control-plane's cloud-gateways configuration.
11 properties8 required
NetworkStateMetadata
object
Metadata describing the backing state of the network and why it may be in an erroneous state.
2 properties
ConfigurationDataPlaneGroupEnvironmentField
object
Environment variable name and value to set for a data-plane group.
2 properties2 required
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
ForbiddenError
UnauthorizedError
ConfigurationDataPlaneGroupEnvironment
array
Array of environment variables to set for a data-plane group.
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…
NetworksFilterParameters
object
2 properties
PatchNetworkRequest
object
Request schema for updating a network.
1 property
CreateNetworkRequest
object
Request schema for creating a network.
6 properties5 required
PaginatedMeta
object
returns the pagination information
1 property1 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 properties3 required
ProviderName
string
Name of cloud provider.
ApiAccess
string
Type of API access data-plane groups will support for a configuration.
Network
object
Object containing information about a network to be used in configurations.
15 properties14 required
NetworkStateFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
DataPlaneGroupId
string
ID of the data-plane group that represents a deployment target for a set of data-planes.
ConfigurationDataPlaneGroup
object
Object that describes the set of data-plane groups currently pointed to this configuration.
12 properties6 required
InvalidRules
string
invalid parameters rules
NetworkName
string
Human-readable name of the network.
InstanceTypeName
string
Instance type name to indicate capacity.
BadRequestError
InvalidParameters
array
invalid parameters
InvalidParameterStandard
object
4 properties2 required
ProviderRegionId
string
Region ID for cloud provider region.
NetworkAvailabilityZones
array
List of availability zones that the network is attached to.
ProviderAccountId
string
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
NetworkCIDRBlock
string
CIDR block configuration for the network.
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
ConfigurationDataPlaneGroupAutoscale
Specification
The full machine-readable OpenAPI contract behind this narrative.
