ListPortalProductVersions

object

A paginated list response for a collection of portal product versions

* Additional properties are NOT allowed.
dataarray[object]required

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
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

PublishedApiProduct

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstringrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-items

The list of portal identifiers which this API product is published to

>= 0 items

Example:25a2624c-49fc-4764-99e1-224ed819f200

version_countnumberrequired

The number of published product versions attached to this API product

Example:10

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

labelsobjectrequired

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:{"env":"test"}

Example

Portal

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The name of the portal, used to distinguish it from other portals. Name must be unique.

>= 1 characters<= 255 characters

display_namestringrequired

The display name of the portal. This value will be the portal’s name in Portal API.

>= 1 characters<= 255 characters

descriptionstringrequired

The description of the portal.

<= 512 characters

default_domainstring(hostname)requiredread-only

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

is_publicbooleanrequired

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabledbooleanrequired

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

auto_approve_applicationsbooleanrequired

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developersbooleanrequired

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domainstring(hostname)required

The custom domain to access the developer portal. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.

custom_client_domainstring(hostname)required

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_idstring(uuid)

Default strategy ID applied on applications for the portal

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

labelsobject

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:{"env":"test"}

application_countnumberrequired

Number of applications created in the portal.

developer_countnumberrequired

Number of developers using the portal.

published_product_countnumberrequired

Number of api products published to the portal

Example

Portal

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The name of the portal, used to distinguish it from other portals. Name must be unique.

>= 1 characters<= 255 characters

display_namestringrequired

The display name of the portal. This value will be the portal’s name in Portal API.

>= 1 characters<= 255 characters

descriptionstringrequired

The description of the portal.

<= 512 characters

default_domainstring(hostname)requiredread-only

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

is_publicbooleanrequired

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabledbooleanrequired

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

auto_approve_applicationsbooleanrequired

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developersbooleanrequired

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domainstring(hostname)required

The custom domain to access the developer portal. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.

custom_client_domainstring(hostname)required

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_idstring(uuid)

Default strategy ID applied on applications for the portal

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

labelsobject

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:{"env":"test"}

application_countnumberrequired

Number of applications created in the portal.

developer_countnumberrequired

Number of developers using the portal.

published_product_countnumberrequired

Number of api products published to the portal

Example

Portal

object
* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

The name of the portal, used to distinguish it from other portals. Name must be unique.

>= 1 characters<= 255 characters

display_namestringrequired

The display name of the portal. This value will be the portal’s name in Portal API.

>= 1 characters<= 255 characters

descriptionstringrequired

The description of the portal.

<= 512 characters

default_domainstring(hostname)requiredread-only

The domain assigned to the portal by Konnect. This is the default place to access the portal and its API if not using a `custom_domain``.

is_publicbooleanrequired

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabledbooleanrequired

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

auto_approve_applicationsbooleanrequired

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developersbooleanrequired

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domainstring(hostname)required

The custom domain to access the developer portal. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.

custom_client_domainstring(hostname)required

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal client will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_idstring(uuid)

Default strategy ID applied on applications for the portal

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

labelsobject

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:{"env":"test"}

application_countnumberrequired

Number of applications created in the portal.

developer_countnumberrequired

Number of developers using the portal.

published_product_countnumberrequired

Number of api products published to the portal

Example