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

Changes

Changed in 7 of the 52 revisions of this API.1048

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

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

  • 96118a9cd7f473See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ▲

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

      response-property-became-nullable

    • ○

      the request property labels/additionalProperties/ became nullable

      request-property-became-nullable

    • ○

      the deprecated request property default value false was added

      request-property-default-value-added

    • ○

      the publish_status request property default value unpublished was added

      request-property-default-value-added

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

  • ab1a51b761441See the full diff
    • ▲

      the request property labels/additionalProperties/ became not nullable

      request-property-became-not-nullable

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

  • ddd4be7ea07311See the full diff
    • ▲

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

      response-property-became-nullable

    • ○

      the request property labels/additionalProperties/ became nullable

      request-property-became-nullable

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

  • d833d4dbb1fa11See the full diff
    • ●

      added the new missing_reference enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    • ○

      added the non-success response with the status 409

      response-non-success-status-added

  • 08ead66e9ebb121See the full diff
    • ▲

      added InvalidParameterMaximumLength to the allOf[subschema #2]/invalid_parameters/items/ response property oneOf list for the response status 400

      response-property-one-of-added

    • ●

      added the new min enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/rule response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new min_items enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/rule response property for the response status 400

      response-property-enum-value-added

    • ○

      removed the max_length enum value from the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-removed

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

  • be7c36317ba62See the full diff
    • ○

      added the new optional request property labels

      new-optional-request-property

    • ○

      added the required property labels to the response with the 201 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