How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

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.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Pages API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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 PortalPageInfo (10 properties), PortalPageResponse (10 properties), CreatePortalPageRequest (7 properties), UpdatePortalPageRequest (7 properties). Each schema is shown below with its type and property counts.

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

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
Where this information came from

This is an independent, third-party profile of Kong Pages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.