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 Resource Availability API

The Resource Availability API from Kong — 1 operation(s) for resource availability.

Kong Resource Availability 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 Resource Availability. 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 1 operation across 1 path, and defines 19 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}.

1 operations 1 paths 19 schemas 1 GET

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 Resource Availability 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Resource Availability 1
GET
/v2/cloud-gateways/availability.json
Get Resource Availability JSON
get-availability-json → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ProviderRegion (5 properties), AvailabilityDocument (4 properties), InstanceType (4 properties), Provider (2 properties). Each schema is shown below with its type and property counts.

Provider
object
Description of cloud provider that runs cloud gateway instances.
2 properties 2 required
ServerlessV1ProviderName
string
Name of cloud provider.
ProviderRegionName
string
Human-readable name for cloud provider region. The list of available provider regions can be retrieved via the availability endpoint /v2/cloud-gateways/availab…
GatewayVersion
string
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
ServerlessV1ProviderRegionId
string
Region ID for serverless v1 cloud provider region.
InstanceType
object
Resource parameters and pricing of a given supported instance type.
4 properties 4 required
ServerlessV1ProviderRegions
array
List of available regions to run serverless v1 cloud gateway instances on for a given cloud provider.
ProviderRegion
object
Region ID and human-readable name for a cloud provider region.
5 properties 5 required
ProviderRegions
array
List of available regions to run cloud gateway instances on for a given cloud provider.
ProviderName
string
Name of cloud provider.
VersionList
array
List of supported gateway versions for cloud gateways.
AvailabilityDocument
object
Document containing availability information for configurations.
4 properties 4 required
ServerlessV1Providers
array
List of supported cloud providers that run serverless v1 cloud gateway instances.
Providers
array
List of supported cloud providers that run cloud gateway instances.
ServerlessV1ProviderRegion
object
Region ID and human-readable name for a cloud provider region.
1 property 1 required
ServerlessV1Provider
object
Description of cloud provider that runs serverless v1 cloud gateway instances.
2 properties 2 required
ProviderRegionId
string
Region ID for cloud provider region.
InstanceTypes
array
List of supported instance types, along with their associated resource parameters and pricing.
InstanceTypeName
string
Instance type name to indicate capacity.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-resource-availability-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