Create Portal
Creates a new developer portal scoped in this region for this organization.
Body
application/json
Body
Create a portal.
Portal
The name of the portal, used to distinguish it from other portals. Name must be unique.
>= 1 characters<= 255 characters
The display name of the portal. This value will be the portal’s name in Portal API.
>= 1 characters<= 255 characters
A description of the portal.
<= 512 characters
Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.
Default:true
Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.
Default:false
Whether ip allow list is enabled for the portal.
Default:false
Example:true
The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.
Allowed values:publicprivate
The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.
Allowed values:publicprivate
The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.
Default:false
Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.
Default:false
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Use to create the portal page default content upon creation of this portal
Default:false
Response
application/json
Response
Details about a portal.
Portal
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The name of the portal, used to distinguish it from other portals. Name must be unique.
>= 1 characters<= 255 characters
The display name of the portal. This value will be the portal’s name in Portal API.
>= 1 characters<= 255 characters
A description of the portal.
<= 512 characters
Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.
Default:true
Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for APIs until unless assigned to teams with access to view and consume specific APIs. Authentication must be enabled to use RBAC.
Default:false
Whether ip allow list is enabled for the portal.
Default:false
Example:true
The default visibility of APIs in the portal. If set to public, newly published APIs are visible to unauthenticated developers. If set to private, newly published APIs are hidden from unauthenticated developers.
Allowed values:publicprivate
The default visibility of pages in the portal. If set to public, newly created pages are visible to unauthenticated developers. If set to private, newly created pages are hidden from unauthenticated developers.
Allowed values:publicprivate
The default authentication strategy for APIs published to the portal. Newly published APIs will use this authentication strategy unless overridden during publication. If set to null, API publications will not use an authentication strategy unless set during publication.
Whether developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.
Default:false
Whether requests from applications to register for APIs will be automatically approved, or if they will be set to pending until approved by an admin.
Default:false
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``.
The canonical domain of the developer portal
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"}
Authentication
Body
Portal Custom Domains
APIs related to configuration of Konnect Developer Portals custom domains.
Enable or Disable Domain
Updates the portal domain associated with the portal.
Path Parameters
ID of the portal.
Body
application/json
Body
Create a portal custom domain.
UpdatePortalCustomDomainRequest
Show Child Parameters
Response
application/json
Response
Portal custom domain
PortalCustomDomain
Show Child Parameters
Allowed values:verifiedpending
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Portal Customization
APIs related to customization of Konnect Developer Portals.
Get Customization
Returns the portal customization options.
Path Parameters
ID of the portal.
Response
application/json
Response
The current customization options for a portal.
PortalCustomization
The custom settings of this portal