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

The API Publication API from Kong — 4 operation(s) for api publication.

Kong API Publication 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 API Publication. 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 8 operations across 4 paths, and defines 29 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}.

8 operations 4 paths 29 schemas 2 DELETE4 GET2 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 API Publication 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

API Publication 8
PUT
/v3/api-packages/{apiPackageId}/publications/{portalId}
Publish API Package
publish-api-package-to-portal 2 params body → 200400401403404
GET
/v3/api-packages/{apiPackageId}/publications/{portalId}
Get an API Package Publication
fetch-api-package-publication 2 params → 200401403404
DELETE
/v3/api-packages/{apiPackageId}/publications/{portalId}
Delete API Package Publication
delete-api-package-publication 2 params → 204401403404
GET
/v3/api-publications
List Publications
list-api-publications 4 params → 200400401403404
PUT
/v3/apis/{apiId}/publications/{portalId}
Publish API
publish-api-to-portal 2 params body → 200400401403404
GET
/v3/apis/{apiId}/publications/{portalId}
Get a Publication
fetch-publication 2 params → 200401403404
DELETE
/v3/apis/{apiId}/publications/{portalId}
Delete Publication
delete-publication 2 params → 204401403404
GET
/v3/portals/{portalId}/api-publications
List Portal API Publications
list-portal-api-publications 5 params → 200400401403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PublicationListItem (9 properties), ApiPublicationListItem (9 properties), ApiPublication (6 properties), ApiPublicationFilterParameters (6 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
PublicationListItem
object
An API or API Package publication in a portal
9 properties 8 required
ApiPublicationAuthStrategyIds
array
The auth strategy the API enforces for applications in the portal. Omitting this property means the portal's default application auth strategy will be used. Se…
ApiPublicationListItem
object
An API publication in a portal
9 properties 8 required
ForbiddenError
UnauthorizedError
PortalApiPublicationFilterParameters
object
API Publication filters excluding portal-specific fields (since portal is already specified in path)
4 properties
PaginatedMeta
object
returns the pagination information
1 property 1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
AutoApproveRegistrations
boolean
Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's autoapproveapplications value.
InvalidParameterDependentItem
object
5 properties 4 required
ApiPublication
object
An API publication in a portal
6 properties
InvalidRules
string
invalid parameters rules
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
ApiPackagePublication
object
An API Package publication in a portal
6 properties
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
EntityType
string
The type of entity that is being published. Can be either an API or an API Package.
ApiPublicationFilterParameters
object
6 properties
ApiPublicationVisibility
string
The visibility of the API in the portal. Public API publications do not require authentication to view and retrieve information about them. Private API publica…
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-api-publication-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