API Product Versions

Create API Product Version

Creates a version of an API product.

post

Path Parameters

apiProductIdstring(uuid)required

The API Product ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Create API Product Version Request

The request schema to create a version of an API product.
Note that the publish_status and deprecated fields are deprecated: Use PortalProductVersion.publish_status instead.

* Additional properties are NOT allowed.
namestringrequired

The version name of the API product version.

>= 1 characters

Example:v1

publish_statusstringDEPRECATED

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

Default:unpublished

Example:unpublished

deprecatedbooleanDEPRECATED

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.

Default:false

Example:false

labelsobject

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"}

gateway_serviceOne Of
GatewayServicePayloadobject | null
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

API product

API Product Version

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product version identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The version of the API product

Example:FirstVersion

gateway_serviceobject | nullrequired
* Additional properties are NOT allowed.
Show Child Parameters
publish_statusstringrequiredDEPRECATED

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

deprecatedbooleanrequiredDEPRECATED

Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead

Example:false

labelsobjectrequired

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"}

auth_strategy_sync_errorsarray | null[object]read-only

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"}

* Additional properties are NOT allowed.
Show Child Parameters
portalsarray[object]required

The list of portals which this API product version is configured for

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/api-products/{apiProductId}/product-versions

Body

{ "name": "v1" }
 
application/json

List API Product Versions

Returns a collection of all versions for an API product.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters API Product Versions in the response.

Show Child Parameters
sortstring

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

apiProductIdstring(uuid)required

The API Product ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of API products

ListAPIProductVersionsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/api-products/{apiProductId}/product-versions
 
application/json

Get an API Product Version

Returns a version of an API product.

get

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

idstring(uuid)required

The API product version identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

API product

API Product Version

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product version identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The version of the API product

Example:FirstVersion

gateway_serviceobject | nullrequired
* Additional properties are NOT allowed.
Show Child Parameters
publish_statusstringrequiredDEPRECATED

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

deprecatedbooleanrequiredDEPRECATED

Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead

Example:false

labelsobjectrequired

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"}

auth_strategy_sync_errorsarray | null[object]read-only

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"}

* Additional properties are NOT allowed.
Show Child Parameters
portalsarray[object]required

The list of portals which this API product version is configured for

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/api-products/{apiProductId}/product-versions/{id}
 
application/json

Update an API Product Version

Updates an API product version.

patch

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

idstring(uuid)required

The API product version identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Body

application/json

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.

* Additional properties are NOT allowed.
namestring

The version name of the API product version.

>= 1 characters

Example:v1

publish_statusstringDEPRECATED

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

deprecatedbooleanDEPRECATED

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

notifyboolean

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

gateway_serviceAny Of
GatewayServicePayloadobject | null
* Additional properties are NOT allowed.
Show Child Parameters
labelsobject | null

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

API product

API Product Version

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product version identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The version of the API product

Example:FirstVersion

gateway_serviceobject | nullrequired
* Additional properties are NOT allowed.
Show Child Parameters
publish_statusstringrequiredDEPRECATED

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

deprecatedbooleanrequiredDEPRECATED

Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead

Example:false

labelsobjectrequired

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"}

auth_strategy_sync_errorsarray | null[object]read-only

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"}

* Additional properties are NOT allowed.
Show Child Parameters
portalsarray[object]required

The list of portals which this API product version is configured for

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/api-products/{apiProductId}/product-versions/{id}

Body

{ "gateway_service": { "control_plane_id": "e4d9ebb1-26b4-426a-b00e-cb67044f3baf", "id": "09b4786a-3e48-4631-8f6b-62d1d8e1a7f3" } }
 
application/json