Sign in
API Product Versions

Get an API Product Version

Returns a version of an API product.

get/v2/api-products/{apiProductId}/product-versions/{id}

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

Changes

Changed in 3 of the 52 revisions of this API.31

  • 96118a9cd7f42See the full diff
    • ▲

      the response property gateway_service/runtime_group_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property labels/additionalProperties/ became nullable for the status 200

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ddd4be7ea0731See the full diff
    • ▲

      the response property labels/additionalProperties/ became nullable for the status 200

      response-property-became-nullable

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • be7c36317ba61See the full diff
    • ○

      added the required property labels to the response with the 200 status

      response-required-property-added

    This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog