API Product Version

object
* 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_serviceobjectrequired
* 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

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[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

Example

API Product Version Spec

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

The API product version specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

namestringrequired

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

Example:oas.yaml

contentstringrequired

The contents of the API product version specification

Example:My YAML or JSON formatted OAS content

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

Example

Create API Product Request

object

The request schema to create an API product.

* Additional properties are NOT allowed.
namestringrequired

The name of the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring

The description of the API product.

Default:null

Example:Text describing the API product

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

public_labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Example:25a2624c-49fc-4764-99e1-224ed819f200

Example

Update API Product Request

object

The request schema for updating an API product.

* Additional properties are NOT allowed.
namestring

The name for the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring

The description of the API product.

Example:Text describing the API product

labelsobject

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

public_labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Example:25a2624c-49fc-4764-99e1-224ed819f200

Example

Create API Product Version Request

object

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

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
* Additional properties are NOT allowed.
Show Child Parameters
Example