Kong Add-Ons 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 Add-Ons. 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 53 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}.
The identity and technical contract details declared by the specification.
AddOnStateFieldEqualsFilter
Filter add-on state by exact match.
InvalidParameterMinimumLength
object
5 properties
4 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
ManagedCacheCapacityConfig
object
Configuration for managed cache capacity and performance characteristics.
AddOnConfigKind
string
Type of add-on config.
UpdateAddOnRequest
object
Request body for updating an add-on.
1 property
1 required
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo by exact match.
AddOnConfigKindFieldFilter
Filter for add-on config kind field.
CreateManagedCacheAddOnConfig
object
Configuration for creating a managed cache add-on.
2 properties
2 required
InvalidParameterChoiceItem
object
5 properties
4 required
UpdateManagedCacheAddOnConfig
object
Configuration for updating a managed cache add-on.
2 properties
2 required
AddOnState
string
The current state of the add-on. Possible values: - initializing - The add-on is in the process of being initialized/updated. - ready - The add-on is fully ope…
InvalidParameterMaximumLength
object
5 properties
4 required
CreateAddOnConfig
object
Configuration for creating different types of add-ons.
AddOnsFilterParameters
object
Filter parameters for add-ons list operation.
7 properties
AddOnName
string
Unique human-readable name of the add-on.
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
AddOnStateFieldOrEqualityFilter
object
Filter add-on 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
AddOnConfigKindFieldEqualsFilter
Filter add-on config kind by exact match.
CloudGatewaysStringFieldFilterOverride
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
ManagedCacheAddOnConfigResponse
object
Configuration for managed cache add-on.
4 properties
4 required
TieredCapacityConfig
object
Capacity tiers with pre-configured size and performance characteristics.
2 properties
2 required
AddOnOwner
object
Owner for the add-on.
ControlPlaneAddOnOwner
object
Control Plane is the owner for the add-on.
3 properties
3 required
AddOnStateFieldEqualsComparison
object
1 property
1 required
AddOnConfigResponse
object
Configuration object for different types of add-ons.
PaginatedMeta
object
returns the pagination information
1 property
1 required
ProviderName
string
Name of cloud provider.
CreateAddOnRequest
object
Request schema for creating an add-on.
3 properties
3 required
AddOnConfigKindFieldNotEqualsFilter
object
Filter add-on config kind by inequality match.
1 property
1 required
BaseError
object
standard error
5 properties
4 required
InvalidParameterDependentItem
object
5 properties
4 required
ControlPlaneGeoFieldFilter
InvalidRules
string
invalid parameters rules
ControlPlaneGeoFieldOrEqualityFilter
object
Filter a control-plane geo 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
InvalidParameters
array
invalid parameters
ManagedCacheAddOnDataPlaneGroup
object
Object that describes a data-plane group where managed cache add-on is deployed.
6 properties
6 required
UpdateAddOnConfig
object
Configuration for updating different types of add-ons.
ControlPlaneGroupAddOnOwner
object
Control Plane Group is the owner for the add-on.
3 properties
3 required
InvalidParameterStandard
object
4 properties
2 required
AddOnResponse
object
Object containing information about an add-on.
8 properties
8 required
AddOnConfigKindFieldEqualsComparison
object
1 property
1 required
AddOnConfigKindFieldOrEqualityFilter
object
Filter add-on config kind by determining if the value is equal to any in a set of values.
1 property
1 required
AddOnStateFieldNotEqualsFilter
object
Filter add-on state by inequality match.
1 property
1 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties
3 required
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Kong publishes across the network.
