Sign in

v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
API Product Versions

Create API Product Version

Creates a version of an API product.

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

Request body

namestring required

The version name of the API product version.

publish_status'unpublished' | 'published'

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.

deprecatedboolean

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.

labelsLabels

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 request

{
  "name": "v1",
  "publish_status": "unpublished",
  "labels": {
    "env": "test"
  },
  "gateway_service": {
    "id": "09b4786a-3e48-4631-8f6b-62d1d8e1a7f3",
    "control_plane_id": "e4d9ebb1-26b4-426a-b00e-cb67044f3baf"
  }
}

Response

API product

idstring uuid required

The API product version identifier.

namestring required

The version of the API product

publish_status'unpublished' | 'published' required

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.

deprecatedboolean required

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

labelsLabels required

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 "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  "name": "FirstVersion",
  "gateway_service": {
    "id": "09b4786a-3e48-4631-8f6b-62d1d8e1a7f3",
    "runtime_group_id": "e4d9ebb1-26b4-426a-b00e-cb67044f3baf",
    "control_plane_id": "e4d9ebb1-26b4-426a-b00e-cb67044f3baf"
  },
  "publish_status": "unpublished",
  "labels": {
    "env": "test"
  },
  "auth_strategy_sync_errors": [
    {
      "plugin_name": "konnect-application-auth",
      "value": "plugin_sync_error_comm",
      "message": "Unable to connect to the control plane to update plugin"
    }
  ],
  "portals": [
    {
      "portal_id": "35a2624c-49fc-4764-99e1-224ed819f200",
      "portal_name": "Developer Portal",
      "portal_product_version_id": "35a2624c-49fc-4764-99e1-224ed819f200",
      "publish_status": "published",
      "application_registration_enabled": true,
      "auth_strategies": [
        {
          "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
          "name": "Key Auth"
        }
      ]
    }
  ],
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}