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 Pages API

APIs related to Konnect Developer Portal Custom Pages.

Kong Pages 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 Pages. 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 7 operations across 4 paths, and defines 35 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}.

7 operations 4 paths 35 schemas 1 DELETE2 GET1 PATCH3 POST

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 Pages 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 7

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

Pages 7

APIs related to Konnect Developer Portal Custom Pages.

POST
/v3/portals/{portalId}/default-content
Create Boilerplate Content
create-default-content 1 param → 201401403404
GET
/v3/portals/{portalId}/pages
List Pages
list-portal-pages 3 params → 200400401404
POST
/v3/portals/{portalId}/pages
Create Page
create-portal-page 1 param body → 201400401403404
GET
/v3/portals/{portalId}/pages/{pageId}
Get a Page
get-portal-page 2 params → 200401404
PATCH
/v3/portals/{portalId}/pages/{pageId}
Update Page
update-portal-page 2 params body → 200400401403404
DELETE
/v3/portals/{portalId}/pages/{pageId}
Delete Page
delete-portal-page 2 params → 204401403404
POST
/v3/portals/{portalId}/pages/{pageId}/move
Move Page
move-portal-pages 2 params body → 201400401403404409

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are PortalPageResponse (10 properties), PortalPageInfo (10 properties), UpdatePortalPageRequest (7 properties), CreatePortalPageRequest (7 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
ListPortalPagesResponse
object
Tree of custom pages in a portal. Not paginated.
1 property 1 required
PageSlug
string
The slug of a page in a portal, used to compute its full URL path within the portal hierarchy. When a page has a parentpageid, its full path is built by joinin…
DefaultContent
object
Summary of created default content
2 properties 2 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 required
PageVisibilityStatus
string
Whether a page is publicly accessible to non-authenticated users. If not provided, the defaultpagevisibility value of the portal will be used.
Description
string
InvalidParameterMaximumLength
object
5 properties 4 required
MovePageRequestPayload
object
move page request payload
2 properties
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
UUID
string
Contains a unique identifier used for this resource.
ForbiddenError
UnauthorizedError
PageTitle
string
The title of a page in a portal.
PublishedStatus
string
Whether the resource is visible on a given portal. Defaults to unpublished.
ParentPageId
string
Pages may be rendered as a tree of files. Specify the id of another page as the parentpageid to add some hierarchy to your pages.
CreatePortalPageRequest
object
Create a page in a portal.
7 properties 2 required
PortalPageResponse
object
Details about a page in a portal.
10 properties 9 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
PortalPageInfo
object
Information about a page in a portal.
10 properties 9 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
PageContent
string
The renderable markdown content of a page in a portal.
PortalPagesFilterParameters
object
6 properties
UpdatePortalPageRequest
object
Update a page in a portal.
7 properties
VisibilityStatus
string
Whether the resource is publicly accessible to non-authenticated users.
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-pages-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