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

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

# Create API Product Version

`POST` `/api-products/{apiProductId}/product-versions`

Operation ID: `create-api-product-version`

Creates a version of an API product.

## Path parameters

- `apiProductId` (string, uuid, required) - The API Product ID

## Request body (required)

Content types: `application/json`

## Responses

- `201` - API product
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `409` - Conflict - V3 API is currently linked to the target gateway service
- `415` - Unsupported Media Type

## 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
paths:
  /api-products/{apiProductId}/product-versions:
    parameters:
      - name: apiProductId
        in: path
        description: The API Product ID
        required: true
        schema:
          type: string
          format: uuid
          example: d32d905a-ed33-46a3-a093-d8f536af9a8a
    post:
      operationId: create-api-product-version
      summary: Create API Product Version
      description: Creates a version of an API product.
      requestBody:
        $ref: "#/components/requestBodies/CreateAPIProductVersionRequest"
      responses:
        "201":
          $ref: "#/components/responses/APIProductVersionResponse"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                APIProductVersionNameBadRequestExample:
                  $ref: "#/components/examples/APIProductNameBadRequestExample"
        "401":
          $ref: "#/components/responses/ApiProductUnauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/ApiProductNotFound"
        "409":
          $ref: "#/components/responses/ApiProductImplementationConflict"
        "415":
          $ref: "#/components/responses/UnsupportedMediaType"
      tags:
        - API Product Versions
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    CreateAPIProductVersionRequest:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateAPIProductVersionDTO"
          examples:
            UnlinkedAPIProductVersion:
              $ref: "#/components/examples/CreateAPIProductVersionRequestMinimalExample"
            LinkedAPIProductVersion:
              $ref: "#/components/examples/CreateLinkedAPIProductVersionRequestExample"
  responses:
    APIProductVersionResponse:
      description: API product
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/APIProductVersion"
          examples:
            Create API Product Response:
              $ref: "#/components/examples/APIProductVersionExample"
    ApiProductUnauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            ForbiddenExample:
              $ref: "#/components/examples/ForbiddenExample"
    ApiProductNotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    ApiProductImplementationConflict:
      description: Conflict - V3 API is currently linked to the target gateway service
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
          examples:
            VersionSpecConflictExample:
              $ref: "#/components/examples/ApiProductImplementationConflictExample"
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnsupportedMediaTypeError"
          examples:
            UnsupportedMediaTypeExample:
              $ref: "#/components/examples/UnsupportedMediaTypeExample"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    CreateAPIProductVersionDTO:
      description: |
        The request schema to create a version of an API product.
        Note that the `publish_status` and `deprecated` fields are deprecated:  Use [PortalProductVersion.publish_status](https://docs.konghq.com/konnect/api/portal-management/v2/#/operations/create-portal-product-version) instead.
      type: object
      properties:
        name:
          description: The version name of the API product version.
          type: string
          example: v1
          minLength: 1
          nullable: false
        publish_status:
          description: "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](https://docs.konghq.com/konne\
            ct/api/portal-management/v2/#/operations/create-portal-product-vers\
            ion) instead."
          type: string
          example: unpublished
          default: unpublished
          enum:
            - unpublished
            - published
          deprecated: true
          nullable: false
        deprecated:
          description: "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](https://docs.konghq.com/konnect/a\
            pi/portal-management/v2/#/operations/create-portal-product-version)
            instead."
          type: boolean
          example: false
          default: false
          deprecated: true
          nullable: false
        labels:
          $ref: "#/components/schemas/Labels"
        gateway_service:
          oneOf:
            - $ref: "#/components/schemas/GatewayServicePayload"
            - $ref: "#/components/schemas/LegacyGatewayServicePayload"
      additionalProperties: false
      required:
        - name
      title: Create API Product Version Request
    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
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ConflictError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 409
            title:
              example: Conflict
            type:
              example: https://httpstatuses.com/409
            instance:
              example: kong:trace:1234567890
            detail:
              example: Conflict
    UnsupportedMediaTypeError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 415
            title:
              example: UnsupportedMediaType
            type:
              example: https://httpstatuses.com/415
            instance:
              example: kong:trace:1234567890
            detail:
              example: UnsupportedMediaType
    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
    GatewayServicePayload:
      type: object
      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
        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
      additionalProperties: false
      nullable: true
      required:
        - id
        - control_plane_id
    LegacyGatewayServicePayload:
      type: object
      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
        runtime_group_id:
          description: The identifier of the control plane that the gateway service
            resides in
          type: string
          format: uuid
          example: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          deprecated: true
      additionalProperties: false
      nullable: true
      required:
        - id
        - runtime_group_id
    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
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    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
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
    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
  examples:
    APIProductNameBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:8405749052424858251
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: min_length
            minimum: 1
            reason: name must be longer than or equal to 1 characters
    CreateAPIProductVersionRequestMinimalExample:
      summary: Create API Product Request (Minimal)
      value:
        name: v1
    CreateLinkedAPIProductVersionRequestExample:
      summary: Create API Product Request
      value:
        name: v1
        publish_status: unpublished
        deprecated: false
        gateway_service:
          control_plane_id: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          id: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
    APIProductVersionExample:
      value:
        id: 9f5061ce-78f6-4452-9108-ad7c02821fd5
        name: v1
        gateway_service:
          runtime_group_id: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          control_plane_id: e4d9ebb1-26b4-426a-b00e-cb67044f3baf
          id: 09b4786a-3e48-4631-8f6b-62d1d8e1a7f3
        publish_status: unpublished
        deprecated: false
        labels:
          env: test
        portals:
          - portal_id: 35a2624c-49fc-4764-99e1-224ed819f200
            portal_name: Developer Portal
            portal_product_version_id: 35a2624c-49fc-4764-99e1-224ed819f200
            publish_status: published
            deprecated: false
            application_registration_enabled: true
            auto_approve_registration: false
            auth_strategies:
              - id: 9f5061ce-78f6-4452-9108-ad7c02821fd5
                name: Key Auth
        created_at: 2023-01-01T00:00:00.000Z
        updated_at: 2023-01-01T00:00:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    ApiProductImplementationConflictExample:
      value:
        status: 409
        title: Conflict
        instance: kong:trace:9039922446017540182
        detail: This gateway service is already linked to a V3 API
    UnsupportedMediaTypeExample:
      value:
        status: 415
        title: Unsupported Media Type
        instance: kong:trace:8347343766220159418
        detail: "This API only supports requests with `Content-Type: application/json`"
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
