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 Portals IP Allow List API

APIs related to Konnect Portal IP Allow List.

Kong Portals IP Allow List 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 Portals IP Allow List. 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 16 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 16 schemas 1 DELETE1 GET1 PATCH1 POST1 PUT

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 Portals IP Allow List 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, 1 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Portals IP Allow List 5

APIs related to Konnect Portal IP Allow List.

POST
/v3/portals/{portalId}/ip-allow-list
Create an IP allow list for a portal
create-portal-ip-allow-list 1 param body → 201400401403
GET
/v3/portals/{portalId}/ip-allow-list
List the IP allow list for portal
list-portal-ip-allow-list 4 params → 200401403404
PUT
/v3/portals/{portalId}/ip-allow-list/{id}
Replace an IP allow list for a portal
put-portal-ip-allow-list 2 params body → 200400401403404
PATCH
/v3/portals/{portalId}/ip-allow-list/{id}
Update an IP allow list for a portal
update-portal-ip-allow-list 2 params body → 200400401403404
DELETE
/v3/portals/{portalId}/ip-allow-list/{id}
Delete an IP allow list from a portal
delete-portal-ip-allow-list 2 params → 204401403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are InvalidParameterMinimumLength (5 properties), BaseError (5 properties), CursorMetaPage (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
PortalAllowedIPs
array
The list of allowed ips for the portal.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
ForbiddenError
UnauthorizedError
CursorMetaPage
object
5 properties 3 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
IPEntries
array
The list of allowed ips for the portal.
InvalidParameterStandard
object
4 properties 2 required
IPEntry
object
An entry representing a collection of allowed IP addresses or CIDR blocks.
2 properties 2 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-portals-ip-allow-list-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