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

The API Packages API from Kong — 2 operation(s) for api packages.

Kong API Packages 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 Packages. 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 28 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 28 schemas 1 DELETE2 GET1 PATCH1 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 API Packages 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, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

API Packages 5
GET
/v3/api-packages
List API Packages
list-api-packages 4 params → 200401403404
POST
/v3/api-packages
Create API Package
create-api-package body → 201400401403404
GET
/v3/api-packages/{packageId}
Get API Package
get-api-package 1 param → 200401403404
PATCH
/v3/api-packages/{packageId}
Patch API Package
patch-api-package 1 param body → 200400401403
DELETE
/v3/api-packages/{packageId}
Delete API Package
delete-api-package 1 param → 204401403404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ApiPackageResponseSchema (10 properties), ApiPackageFilterParameters (7 properties), InvalidParameterDependentItem (5 properties), BaseError (5 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.
ApiPackageResponseSchema
object
10 properties 9 required
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
RateLimitingConfig
object
Rate limit configuration that can be applied to an API Package or an API Package Operation.
2 properties 2 required
ApiAttributes
object
A set of attributes that describe the API
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
UnauthorizedError
ForbiddenError
AttributesFieldFilter
LabelsUpdate
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Labels are intended to store INTERNAL me…
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
InvalidParameterDependentItem
object
5 properties 4 required
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…
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
LabelsFieldFilter
InvalidParameterStandard
object
4 properties 2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
ApiPackageFilterParameters
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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