Create Portal

Creates a new developer portal scoped in this region for this organization.

post

Body

application/json

Create a portal.

Portal

* Additional properties are NOT allowed.
namestringrequired

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

>= 1 characters<= 255 characters

display_namestring

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

>= 1 characters<= 255 characters

descriptionstring | null

A description of the portal.

<= 512 characters

authentication_enabledboolean

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

Default:true

rbac_enabledboolean

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

sipr_enabledboolean

Whether ip allow list is enabled for the portal.

Default:false

Example:true

default_api_visibilitystring

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

default_page_visibilitystring

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

default_application_auth_strategy_idstring | null(uuid)

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.

auto_approve_developersboolean

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

Default:false

auto_approve_applicationsboolean

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

labelsobject | null

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

Details about a portal.

Portal

* 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

descriptionstring | nullrequired

A description of the portal.

<= 512 characters

authentication_enabledbooleanrequired

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

Default:true

rbac_enabledbooleanrequired

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

sipr_enabledbooleanrequired

Whether ip allow list is enabled for the portal.

Default:false

Example:true

default_api_visibilitystringrequired

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

default_page_visibilitystringrequired

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

default_application_auth_strategy_idstring | null(uuid)required

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.

auto_approve_developersbooleanrequired

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

Default:false

auto_approve_applicationsbooleanrequired

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

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``.

canonical_domainstring(hostname)requiredread-only

The canonical domain of the developer portal

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"}

post/portals

Body

{ "name": "MyDevPortal", "authentication_enabled": true, "rbac_enabled": true, "auto_approve_applications": false, "auto_approve_developers": false }
 
application/json

Get a Portal

Returns the configuration for a single developer portal, including the current visibility, access, and domain settings.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a portal.

Portal

* 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

descriptionstring | nullrequired

A description of the portal.

<= 512 characters

authentication_enabledbooleanrequired

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

Default:true

rbac_enabledbooleanrequired

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

sipr_enabledbooleanrequired

Whether ip allow list is enabled for the portal.

Default:false

Example:true

default_api_visibilitystringrequired

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

default_page_visibilitystringrequired

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

default_application_auth_strategy_idstring | null(uuid)required

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.

auto_approve_developersbooleanrequired

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

Default:false

auto_approve_applicationsbooleanrequired

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

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``.

canonical_domainstring(hostname)requiredread-only

The canonical domain of the developer portal

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"}

get/portals/{portalId}
 
application/json

Update Portal

Updates the configuration for a single portal including the visibility, access, and custom domain settings.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a portal’s settings.

Portal

* Additional properties are NOT allowed.
namestring

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

>= 1 characters<= 255 characters

display_namestring

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

>= 1 characters<= 255 characters

descriptionstring | null

A description of the portal.

<= 512 characters

authentication_enabledboolean

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

Default:true

rbac_enabledboolean

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

sipr_enabledboolean

Whether ip allow list is enabled for the portal.

Default:false

Example:true

default_api_visibilitystring

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

default_page_visibilitystring

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

default_application_auth_strategy_idstring | null(uuid)

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.

auto_approve_developersboolean

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

Default:false

auto_approve_applicationsboolean

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

labelsobject | null

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

Details about a portal.

Portal

* 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

descriptionstring | nullrequired

A description of the portal.

<= 512 characters

authentication_enabledbooleanrequired

Whether the portal supports developer authentication. If disabled, developers cannot register for accounts or create applications.

Default:true

rbac_enabledbooleanrequired

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

sipr_enabledbooleanrequired

Whether ip allow list is enabled for the portal.

Default:false

Example:true

default_api_visibilitystringrequired

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

default_page_visibilitystringrequired

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

default_application_auth_strategy_idstring | null(uuid)required

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.

auto_approve_developersbooleanrequired

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

Default:false

auto_approve_applicationsbooleanrequired

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

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``.

canonical_domainstring(hostname)requiredread-only

The canonical domain of the developer portal

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"}

patch/portals/{portalId}

Body

{ "authentication_enabled": false, "rbac_enabled": false, "auto_approve_applications": false, "auto_approve_developers": false }
 
application/json

Delete Portal

Deletes a single portal, along with all related entities.

delete

Query Parameters

forcestring

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

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}
 

Portal Custom Domains

APIs related to configuration of Konnect Developer Portals custom domains.