Get API Package
Get details of a specific API package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
API Package
API Package
The API Package identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API Package. The name + version combination must be unique for each API Package you publish.
>= 1 characters<= 255 characters
Example:MyAPIPackage
A description of your API Package. Will be visible on your live Portal.
The unique slug for your API Package, It should be unique across all APIs and API Packages.
Match pattern:^[\w-]+$
Example:my-api-package-v1
An optional version for your API Package. Leave this empty if your API Package is unversioned.
>= 1 characters<= 255 characters
Rate limit configuration that can be applied to an API Package or an API Package Operation.
Show Child Parameters
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Patch API Package
Updates an existing API package.
You can modify the name, description and version of the API Package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Package
The name of your API Package. The name + version combination must be unique for each API Package you publish.
>= 1 characters<= 255 characters
Example:MyAPIPackage
A description of your API Package. Will be visible on your live Portal.
The unique slug for your API Package, It should be unique across all APIs and API Packages.
Match pattern:^[\w-]+$
Example:my-api-package-v1
An optional version for your API Package. Leave this empty if your API Package is unversioned.
>= 1 characters<= 255 characters
Rate limit configuration that can be applied to an API Package or an API Package Operation.
Show Child Parameters
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 metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
Response
application/json
Response
API Package
API Package
The API Package identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The name of your API Package. The name + version combination must be unique for each API Package you publish.
>= 1 characters<= 255 characters
Example:MyAPIPackage
A description of your API Package. Will be visible on your live Portal.
The unique slug for your API Package, It should be unique across all APIs and API Packages.
Match pattern:^[\w-]+$
Example:my-api-package-v1
An optional version for your API Package. Leave this empty if your API Package is unversioned.
>= 1 characters<= 255 characters
Rate limit configuration that can be applied to an API Package or an API Package Operation.
Show Child Parameters
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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
A set of attributes that describe the API
Default:{}
Example:{"env":["production"],"domains":["web","mobile"]}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete API Package
Deletes an API package.
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
Response
API package was deleted successfully.
Authentication
Path Parameters
API Package Operations
List API Packages Operations
List API packages operations
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters API Packages operations in the response.
Show Child Parameters
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 provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Path Parameters
The UUID API Package identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API Package Operations
ListApiPackageOperationsResponse
returns the pagination information