Portal Product Versions

Replace a portal product version

Changed on

Replace a portal product version

put/v2/portals/{portalId}/product-versions/{productVersionId}

Request

  • Base URL
    https://global.api.konghq.com
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Request body

publish_status'published' | 'unpublished' required

Publication status of the API product version on the portal

auth_strategy_idsUUIDRW[] required

A list of authentication strategy IDs

application_registration_enabledboolean required

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationboolean required

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedboolean required

Whether the api product version on the portal is deprecated

notify_developersboolean

Whether to notify developers who are affected by this change

Example request

{
  "auth_strategy_ids": [
    "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
  ]
}

Response

A response containing a portal product version

idstring uuid required

Contains a unique identifier used for this resource.

publish_status'published' | 'unpublished' required

Publication status of the API product version on the portal

product_version_idstring uuid required

Contains a unique identifier used for this resource.

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.

application_registration_enabledboolean required

Whether the application registration on this portal for the api product version is enabled

auto_approve_registrationboolean required

Whether the application registration auto approval on this portal for the api product version is enabled

deprecatedboolean required

Whether the api product version on the portal is deprecated

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "product_version_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "auth_strategies": [
    {
      "id": "b9e81174-b5bb-4638-a3c3-8afe61a0abf8",
      "name": "name"
    }
  ]
}

Changes

    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status