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
Example:{"icon":{"uri":"/apis/ebbac5b0-ac89-45c3-9d2e-c4542c657e79/images/icon/raw"}}
Show Child Parameters
Authentication
Path Parameters
Body
Create API Version
Creates a version (OpenAPI or AsyncAPI) for an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
API Version
The version of the api.
Example:1.0.0
Show Child Parameters
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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
List API Versions
Returns a list of versions for an API. The version can be of type OpenAPI or AsyncAPI.
Note: You can only have one version for an API.
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 Version 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 identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
List of API specifications (OpenAPI or AsyncAPI)
ListApiSpecResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an API Version
Fetches the version (OpenAPI or AsyncAPI) of an API.
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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
Update API Version
Updates the version (OpenAPI or AsyncAPI) of an API.
Query Parameters
If true, allows operations to be removed from the current version when using access control enforcement.
If false, operations removal will be rejected with a 409 error.
Omitting the value (i.e., setting ?force) means true.
Allowed values:truefalse
Default:false
Path Parameters
The UUID API identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The API version identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
API Version
The version of the api.
Example:1.0.0
Show Child Parameters
Response
application/json
Response
API version (OpenAPI or AsyncAPI)
API Version
The API version identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The version of the api.
Example:1.0.0
Show Child Parameters
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