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 Package Operations API

The API Package Operations API from Kong — 2 operation(s) for api package operations.

Kong API Package Operations 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 Package Operations. 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 4 operations across 2 paths, and defines 27 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}.

4 operations 2 paths 27 schemas 1 DELETE2 GET1 PATCH

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 Package Operations 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 4

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

API Package Operations 4
GET
/v3/api-packages/{packageId}/operations
List API Packages Operations
list-api-packages-operations 5 params → 200401403404
PATCH
/v3/api-packages/{packageId}/operations
Update API Package Operation
update-api-package-operations 1 param body → 204400401403404409
GET
/v3/api-packages/{packageId}/operations/{operationId}
Get API Packages Operation
get-api-packages-operation 2 params → 200401403404
DELETE
/v3/api-packages/{packageId}/operations/{operationId}
Remove API Package Operation
remove-api-package-operation 2 params → 204401403404

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ApiPackageOperationResponseSchema (8 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties), StringFieldFilter (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.
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
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
APIPackageJSONPatchOperation
array
A JSON Patch operation to add or remove API Operations from a Package.
UnauthorizedError
ForbiddenError
Method
string
The HTTP method of an API Operation.
ApiPackageOperationsFilterParameters
object
5 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
InvalidParameterDependentItem
object
5 properties 4 required
ApiOperationImplementationStatus
object
The implementation status of the operation.
3 properties 3 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
InvalidParameterStandard
object
4 properties 2 required
APIPackageJSONPatchItem
object
A JSON Patch operation to add or remove an API Operation from a Package.
3 properties 2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError
ApiPackageOperationResponseSchema
object
8 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-api-package-operations-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