API Product Version Spec
objectThe API product version specification identifier.
Example:7710d5c4-d902-410b-992f-18b814155b53
The name of the API product version specification
Match pattern:^.+(?:\.yaml|\.yml|\.json)$
Example:oas.yaml
The contents of the API product version specification
Example:My YAML or JSON formatted OAS content
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
Create API Product Request
objectThe request schema to create an API product.
The name of the API product.
>= 1 characters<= 100 characters
Example:API Product
The description of the API product.
Default:null
Example:Text describing the API product
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 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"}
The list of portal identifiers which this API product should be published to
>= 0 items
Example:25a2624c-49fc-4764-99e1-224ed819f200
Update API Product Request
objectThe request schema for updating an API product.
The name for the API product.
>= 1 characters<= 100 characters
Example:API Product
The description of the API product.
Example:Text describing the API product
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 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"}
The list of portal identifiers which this API product should be published to
>= 0 items
Example:25a2624c-49fc-4764-99e1-224ed819f200
Create API Product Version Request
objectThe 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.
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
Default:unpublished
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.
Default: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"}
One OfShow Child Parameters
Create API Product Version Specification Request
objectThe request schema to create a specification for a version of an API product.
The name of the API product version specification
Match pattern:^.+(?:\.yaml|\.yml|\.json)$
>= 1 characters<= 255 characters
Example:oas.yaml
The base64 encoded contents of the API product version specification
>= 1 characters
Example:TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==