---
title: "API Product Version"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550/schemas/APIProductVersion"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-products-2/versions/eaf2cded-a760-4559-80d6-16254036c550.md

# API Product Version

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect API Products
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    AuthStrategySyncErrors:
      description: The set of errors encountered when trying to sync the auth
        strategies on the version
      type: array
      items:
        $ref: "#/components/schemas/AuthStrategySyncError"
      example:
        - plugin_name: konnect-application-auth
          value: plugin_sync_error_comm
          message: Unable to connect to the control plane to update plugin
      nullable: true
      readOnly: true
    APIProductVersionPortals:
      description: The list of portals which this API product version is configured for
      type: array
      items:
        $ref: "#/components/schemas/APIProductVersionPortal"
      minItems: 0
      title: APIProductVersionPortals
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    AuthStrategySyncError:
      type: object
      properties:
        plugin_name:
          type: string
        value:
          type: string
          enum:
            - plugin_sync_error_comm
            - plugin_sync_error_unknown
            - plugin_sync_error_fatal
            - plugin_sync_error_updating_plugin_refs
        message:
          type: string
        info:
          type: object
          additionalProperties: true
          properties:
            details:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  type:
                    type: string
                  message:
                    type: array
                    items:
                      type: string
      example:
        plugin_name: konnect-application-auth
        value: plugin_sync_error_comm
        message: Unable to connect to the control plane to update plugin
      additionalProperties: false
      required:
        - message
    APIProductVersionPortal:
      type: object
      properties:
        portal_id:
          type: string
          format: uuid
          example: 35a2624c-49fc-4764-99e1-224ed819f200
        portal_name:
          type: string
          example: Developer Portal
        portal_product_version_id:
          type: string
          format: uuid
          example: 35a2624c-49fc-4764-99e1-224ed819f200
        publish_status:
          $ref: "#/components/schemas/APIProductVersionPublishStatus"
        deprecated:
          type: boolean
          example: false
        application_registration_enabled:
          type: boolean
          example: true
        auto_approve_registration:
          type: boolean
          example: false
        auth_strategies:
          type: array
          items:
            $ref: "#/components/schemas/APIProductVersionAuthStrategy"
      additionalProperties: false
      required:
        - portal_id
        - portal_name
        - portal_product_version_id
        - publish_status
        - deprecated
        - application_registration_enabled
        - auto_approve_registration
        - auth_strategies
      title: APIProductVersionPortal
    APIProductVersionPublishStatus:
      type: string
      example: published
      enum:
        - published
        - unpublished
      title: APIProductVersionPublishStatus
    APIProductVersionAuthStrategy:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        name:
          type: string
          example: Key Auth
      example:
        id: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        name: Key Auth
      additionalProperties: false
      required:
        - id
        - name
      title: APIProductVersionAuthStrategy
    APIProductVersion:
      type: object
      properties:
        id:
          description: The API product version identifier.
          type: string
          format: uuid
          example: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          readOnly: true
        name:
          description: The version of the API product
          type: string
          example: FirstVersion
        gateway_service:
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              description: The identifier of a gateway service associated with the version of
                the API product.
              type: string
              format: uuid
              example: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
              nullable: true
            runtime_group_id:
              description: This field is deprecated, please use `control_plane_id` instead.
                The identifier of the control plane that the gateway service
                resides in
              type: string
              format: uuid
              example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
              deprecated: true
            control_plane_id:
              description: The identifier of the control plane that the gateway service
                resides in
              type: string
              format: uuid
              example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          required:
            - id
            - control_plane_id
        publish_status:
          description: "This field is published if the API product version is published to
            at least one portal. This field is deprecated: Use
            [PortalProductVersion.publish_status](https://docs.konghq.com/konne\
            ct/api/portal-management/v2/#/operations/create-portal-product-vers\
            ion) instead."
          type: string
          example: unpublished
          enum:
            - unpublished
            - published
          deprecated: true
        deprecated:
          description: "Whether this API product version is deprecated in at least one
            portal. This field is deprecated: Use
            [PortalProductVersion.deprecated](https://docs.konghq.com/konnect/a\
            pi/portal-management/v2/#/operations/create-portal-product-version)
            instead"
          type: boolean
          example: false
          deprecated: true
        labels:
          $ref: "#/components/schemas/Labels"
        auth_strategy_sync_errors:
          $ref: "#/components/schemas/AuthStrategySyncErrors"
        portals:
          $ref: "#/components/schemas/APIProductVersionPortals"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      additionalProperties: false
      required:
        - id
        - name
        - gateway_service
        - publish_status
        - deprecated
        - labels
        - portals
        - created_at
        - updated_at
      title: API Product Version
```
