Create Portal

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

post

Body

application/json

Create a portal.

CreatePortalRequest

* 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

The description of the portal.

<= 512 characters

is_publicboolean

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_enabledboolean

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_applicationsboolean

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_developersboolean

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

custom_domainstring | null(hostname)

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.

<= 1024 characters

custom_client_domainstring | null(hostname)

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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.

<= 1024 characters

default_application_auth_strategy_idstring | null(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"}

Response

application/json

Details about the portal that was created.

CreatePortalResponse

* 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

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 | null(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 | null(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 | null(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

post/portals

Body

{ "name": "DevPortal", "is_public": false, "rbac_enabled": true, "auto_approve_applications": false, "auto_approve_developers": false, "custom_domain": "api.example.com", "custom_client_domain": "portal.example.com", "default_application_auth_strategy_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7" }
 
application/json

Get Portal

Returns the configuration for a single developer portal. This allows you to understand the current visibility, access, and domain settings.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a portal and its current settings.

GetPortalResponse

* 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

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 | null(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 | null(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 | null(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

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.

UpdatePortalRequest

* 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

The description of the portal.

<= 512 characters

is_publicboolean

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_enabledboolean

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_applicationsboolean

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_developersboolean

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

custom_domainstring | null(hostname)

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.

<= 1024 characters

custom_client_domainstring | null(hostname)

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal 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.

<= 1024 characters

default_application_auth_strategy_idstring | null(uuid)

Default strategy ID applied on applications for the portal

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

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 the portal being updated.

UpdatePortalResponse

* 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

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 | null(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 | null(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 | null(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

patch/portals/{portalId}

Body

{ "name": "Aperture", "is_public": false, "rbac_enabled": true, "auto_approve_applications": false, "auto_approve_developers": false, "custom_domain": "api.example.com", "custom_client_domain": "portal.example.com", "default_application_auth_strategy_id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7" }
 
application/json

Delete Portal

Deletes a single portal, along with all related entities. Will not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled, unless force=true query param is included in the request.

delete

Query Parameters

forcestring

If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled.

Allowed values:truefalse

Default:false

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}
 

Verify Custom Domains

Verifies the current status of the custom hosted domain for this portal, indicating whether the appropriate CNAME properties have propagated and if a corresponding SSL certificate has been generated.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about the status of a portal’s custom domain.

VerifyPortalDomainsResponse

Details about the current status of a custom domain.

* Additional properties are NOT allowed.
is_cname_verifiedbooleanrequiredread-only
is_ssl_issuedbooleanrequiredread-only
post/portals/{portalId}/verify-domain
 
application/json