APIProductVersionPublishStatus

string

Allowed values:publishedunpublished

Example

APIProductVersionPortals

array

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

>= 0 items

portal_idstring(uuid)required

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

portal_namestringrequired

Example:Developer Portal

portal_product_version_idstring(uuid)required

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

publish_statusstringrequired

Allowed values:publishedunpublished

Example:published

deprecatedbooleanrequired
application_registration_enabledbooleanrequired

Example:true

auto_approve_registrationbooleanrequired
auth_strategiesarray[object]required

Example:{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"Key Auth"}

* Additional properties are NOT allowed.
Show Child Parameters

APIProductVersionPortal

object
* Additional properties are NOT allowed.
portal_idstring(uuid)required

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

portal_namestringrequired

Example:Developer Portal

portal_product_version_idstring(uuid)required

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

publish_statusstringrequired

Allowed values:publishedunpublished

Example:published

deprecatedbooleanrequired
application_registration_enabledbooleanrequired

Example:true

auto_approve_registrationbooleanrequired
auth_strategiesarray[object]required

Example:{"id":"9f5061ce-78f6-4452-9108-ad7c02821fd5","name":"Key Auth"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

APIProductVersionAuthStrategy

object
* Additional properties are NOT allowed.
idstring(uuid)required

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

namestringrequired

Example:Key Auth

Example

API Product

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

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstringrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.

>= 0 items

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

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

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

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

public_labelsobjectrequired

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

Example