---
title: "Create a portal product version"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/operations/create-portal-product-version"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# Create a portal product version

`POST` `/portals/{portalId}/product-versions`

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

Create a portal product version

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - A response containing a portal product version
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
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:
  /portals/{portalId}/product-versions:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    post:
      operationId: create-portal-product-version
      summary: Create a portal product version
      description: Create a portal product version
      requestBody:
        $ref: "#/components/requestBodies/CreatePortalProductVersion"
      responses:
        "201":
          $ref: "#/components/responses/PortalProductVersion"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Product Versions
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  requestBodies:
    CreatePortalProductVersion:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreatePortalProductVersionPayload"
          examples:
            PortalProductVersion:
              $ref: "#/components/examples/PortalProductVersionCreateRequestExample1"
  responses:
    PortalProductVersion:
      description: A response containing a portal product version
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalProductVersion"
          examples:
            PortalProductVersion:
              $ref: "#/components/examples/PortalProductVersionExample1"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      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:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    CreatePortalProductVersionPayload:
      description: Payload to create a Portal Product Version
      type: object
      properties:
        publish_status:
          $ref: "#/components/schemas/PortalProductVersionPublishStatus"
        product_version_id:
          $ref: "#/components/schemas/UUID_RW"
        auth_strategy_ids:
          $ref: "#/components/schemas/AuthStrategyIDs"
        application_registration_enabled:
          $ref: "#/components/schemas/ApplicationRegistrationEnabled"
        auto_approve_registration:
          $ref: "#/components/schemas/AutoApproveRegistration"
        deprecated:
          $ref: "#/components/schemas/PortalProductVersionDeprecated"
      additionalProperties: false
      required:
        - publish_status
        - application_registration_enabled
        - auto_approve_registration
        - product_version_id
        - deprecated
        - auth_strategy_ids
      title: CreatePortalProductVersionPayload
    PortalProductVersion:
      description: >
        A Portal Product Version holds metadata that describes how a Product
        Version is configured for a specific portal.


        It contains:

        - Lifecyle and deprecation statuses

        - Application registration settings like auto approve or whether
        application registration is enabled

        - The Authentication Strategy (if present) that is enabled for
        Application Registration
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        publish_status:
          $ref: "#/components/schemas/PortalProductVersionPublishStatus"
        product_version_id:
          $ref: "#/components/schemas/UUID_RW"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        auth_strategies:
          $ref: "#/components/schemas/AuthStrategies"
        application_registration_enabled:
          $ref: "#/components/schemas/ApplicationRegistrationEnabled"
        auto_approve_registration:
          $ref: "#/components/schemas/AutoApproveRegistration"
        deprecated:
          $ref: "#/components/schemas/PortalProductVersionDeprecated"
      additionalProperties: false
      required:
        - id
        - publish_status
        - application_registration_enabled
        - auto_approve_registration
        - product_version_id
        - deprecated
        - auth_strategies
        - created_at
        - updated_at
      title: PortalProductVersion
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    PortalProductVersionPublishStatus:
      description: Publication status of the API product version on the portal
      type: string
      enum:
        - published
        - unpublished
    UUID_RW:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
    AuthStrategyIDs:
      description: A list of authentication strategy IDs
      type: array
      items:
        $ref: "#/components/schemas/UUID_RW"
      maxItems: 1
      minItems: 0
    ApplicationRegistrationEnabled:
      description: Whether the application registration on this portal for the api
        product version is enabled
      type: boolean
    AutoApproveRegistration:
      description: Whether the application registration auto approval on this portal
        for the api product version is enabled
      type: boolean
    PortalProductVersionDeprecated:
      description: Whether the api product version on the portal is deprecated
      type: boolean
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    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
    AuthStrategies:
      description: A list of authentication strategies
      type: array
      items:
        $ref: "#/components/schemas/AuthStrategy"
      maxItems: 1
      minItems: 0
    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
    AuthStrategy:
      type: object
      discriminator:
        propertyName: credential_type
      oneOf:
        - $ref: "#/components/schemas/AuthStrategyKeyAuth"
        - $ref: "#/components/schemas/AuthStrategyClientCredentials"
    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
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    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
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
  examples:
    PortalProductVersionCreateRequestExample1:
      value:
        product_version_id: 33f8380e-7798-4566-99e3-2edf2b57d289
        auth_strategy_ids:
          - 44f8380e-7798-4566-99e3-2edf2b57d289
        publish_status: published
        application_registration_enabled: true
        auto_approve_registration: true
        deprecated: false
    PortalProductVersionExample1:
      value:
        id: 22f8380e-7798-4566-99e3-2edf2b57d289
        publish_status: published
        product_version_id: 33f8380e-7798-4566-99e3-2edf2b57d289
        auth_strategies:
          - id: 44f8380e-7798-4566-99e3-2edf2b57d289
            name: key auth strategy
            credential_type: key_auth
            key_names:
              - apikey
        application_registration_enabled: true
        auto_approve_registration: true
        deprecated: false
        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
  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...'`
```
