List API Product Versions
Returns a collection of all versions for an API product.
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 Product Versions 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 API Product ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
List of API products
ListAPIProductVersionsResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Get an API Product Version
Returns a version of an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The API product version identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
application/json
Response
API product
API Product Version
The API product version identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The version of the API product
Example:FirstVersion
Show Child Parameters
This field is published if the API product version is published to at least one portal. This field is deprecated: Use PortalProductVersion.publish_status instead.
Allowed values:unpublishedpublished
Example:unpublished
Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead
Example:false
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"}
The set of errors encountered when trying to sync the auth strategies on the version
Example:{"plugin_name":"konnect-application-auth","value":"plugin_sync_error_comm","message":"Unable to connect to the control plane to update plugin"}
Show Child Parameters
The list of portals which this API product version is configured for
>= 0 items
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 an API Product Version
Updates an API product version.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The API product version identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Body
application/json
Body
Update API Product Version Request
The request schema for updating a version of an API product.
Note that the publish_status and deprecated fields are deprecated: Use PortalProductVersion.publish_status instead.
The version name of the API product version.
>= 1 characters
Example:v1
The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.
Allowed values:unpublishedpublished
Example:unpublished
Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.
Example:false
When set to true, and all the following conditions are true:
- version of the API product deprecation has changed from
false->true - version of the API product is published
then consumers of the now deprecated verion of the API product will be notified.
Example:true
Any OfShow 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"}
Response
application/json
Response
API product
API Product Version
The API product version identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The version of the API product
Example:FirstVersion
Show Child Parameters
This field is published if the API product version is published to at least one portal. This field is deprecated: Use PortalProductVersion.publish_status instead.
Allowed values:unpublishedpublished
Example:unpublished
Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead
Example:false
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"}
The set of errors encountered when trying to sync the auth strategies on the version
Example:{"plugin_name":"konnect-application-auth","value":"plugin_sync_error_comm","message":"Unable to connect to the control plane to update plugin"}
Show Child Parameters
The list of portals which this API product version is configured for
>= 0 items
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
Delete API Product Version
Removes an API product version.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The API product version identifier
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
Response
Response
API product version was deleted successfully.