List Portals
Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated configuration, customization, developers, and applications.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Sorts a collection of portals. Supported sort attributes are:
- name
- description
- authentication_enabled
- rbac_enabled
- auto_approve_applications
- auto_approve_developers
- default_domain
- canonical_domain
- created_at
- updated_at
Filter portals returned in the response.
Show Child Parameters
Response
application/json
Response
A paginated list of portals in the current region of an organization.
Show Child Parameters
returns the pagination information
Show Child Parameters
Authentication
Query Parameters
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"}
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
Get a Portal
Returns the configuration for a single developer portal, including the current visibility, access, and domain settings.
Path Parameters
ID of the portal.
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
Path Parameters
Update Portal
Updates the configuration for a single portal including the visibility, access, and custom domain settings.
Path Parameters
ID of the portal.
Body
application/json
Body
Update a portal’s settings.
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"}
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
Path Parameters
Body
Delete Portal
Deletes a single portal, along with all related entities.
Query Parameters
If true, the portal will be deleted, automatically deleting all API publications. If the force param is not set, the deletion will only succeed if there are no APIs currently published.
Allowed values:truefalse
Default:false
Path Parameters
ID of the portal.
Response
Response
No Content