ACLs7

Add-Ons5

AI Gateway Agents5

AI Gateway Auth Strategies5

AI Gateway CA Certificates5

AI Gateway Certificates5

AI Gateway Config Stores10

AI Gateway Consumer Groups8

AI Gateway Consumers11

AI Gateway DataPlane Certificates4

AI Gateway Identity Providers5

AI Gateway MCP Servers5

AI Gateway Model Providers5

AI Gateway Models5

AI Gateway Nodes3

AI Gateway Policies5

AI Gateway SNIs10

AI Gateway Vaults5

AI Gateways6

API6

API Attributes1

API Documentation6

API Image4

API Implementation4

API Operations2

API Package Documentation6

API Package Image4

API Package Operations4

API Package Specification4

API Packages5

API Publication8

API Specification6

API Version5

API-keys7

App Auth Strategies6

Application Registrations8

Applications8

Assets6

Auth Settings17

Authentication1

Basic-auth credentials7

CA Certificates5

Catalog Integrations1

Catalog Resource Mappings4

Catalog Resource Services1

Catalog Resources3

Catalog Service API Mappings5

Catalog Service Resources1

Catalog Services5

Certificates5

Cloud Gateways Resource Quotas3

Config Store Secrets5

Config Stores5

Consumer Groups9

Consumers9

Control Plane Groups6

Control Planes5

Criteria Templates1

Custom Domains5

Custom Plugin Schemas5

CustomPlugins5

Dashboards5

Data-Plane Group Configurations3

DCR Providers6

Degraphql_routes7

DP Certificates5

DP Nodes6

Event Gateway Backend Clusters5

Event Gateway DataPlane Certificates5

Event Gateway Listener Policies9

Event Gateway Listeners5

Event Gateway Nodes4

Event Gateway Schema Registries5

Event Gateway Static Keys4

Event Gateway TLS Trust Bundles5

Event Gateway Virtual Cluster Consume Policies9

Event Gateway Virtual Cluster Policies9

Event Gateway Virtual Cluster Produce Policies9

Event Gateway Virtual Clusters5

Event Gateways6

GraphQL Cost Decorations7

HMAC-auth credentials7

Impersonation Settings2

Integration Instance Auth Config3

Integration Instance Auth Credentials3

Integration Instances5

Invites1

JWTs7

Keys10

KeySets5

MCP Server Runtime1

MCP Servers6

Me2

Metering Events2

Meters6

MTLS-auth credentials7

Networks6

Notifications11

OpenMeter Apps2

OpenMeter Billing Settings5

OpenMeter Customers19

OpenMeter Defaults2

OpenMeter Entitlements1

OpenMeter Features6

OpenMeter LLM Cost5

OpenMeter Product Catalog19

OpenMeter Subscriptions8

OpenMeter Tax5

Pages7

Partial Links1

Partials5

Personal Access Tokens6

Plugins26

Portal Audit Logs6

Portal Auth Settings13

Portal Custom Domains4

Portal Customization3

Portal Developers5

Portal Emails19

Portal Integrations3

Portal Team Membership4

Portal Team Roles4

Portal Teams5

Portals5

Portals IP Allow List6

Private DNS5

Provider Accounts2

Resource Availability1

Resource Configurations3

Roles9

Routes10

Schemas2

Scorecards11

Services5

Skills2

Snippets5

SNIs10

System Accounts5

System Accounts - Access Tokens5

System Accounts - Roles4

System Accounts - Team Membership4

Targets6

Team Membership4

Teams5

Transit Gateways5

Upstreams5

Users4

Vaults5

Portals

Update Portal

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

patch/v3/portals/{portalId}

Request body

idstring uuid

Contains a unique identifier used for this resource.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

namestring

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

display_namestring

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

descriptionstring nullable

A description of the portal.

authentication_enabledboolean

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

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.

sipr_enabledboolean

Whether ip allow list is enabled for the portal.

default_api_visibility'public' | 'private'

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.

default_page_visibility'public' | 'private'

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.

default_application_auth_strategy_idstring uuid nullable

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.

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_domainstring hostname

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

The canonical domain of the developer portal

labelsLabelsUpdate nullable

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 "_".

notifications_developer_pii_visibility_enabledboolean

When enabled, portal registration notifications include the registering developer's identifying information (such as name and email).

Example request

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "sipr_enabled": true,
  "labels": {
    "env": "test"
  }
}

Response

Details about a portal.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

namestring required

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

display_namestring required

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

descriptionstring nullable required

A description of the portal.

authentication_enabledboolean required

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

rbac_enabledboolean required

sipr_enabledboolean required

Whether ip allow list is enabled for the portal.

default_api_visibility'public' | 'private' required

default_page_visibility'public' | 'private' required

default_application_auth_strategy_idstring uuid nullable required

auto_approve_developersboolean required

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

auto_approve_applicationsboolean required

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_domainstring hostname required

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 required

The canonical domain of the developer portal

labelsLabels

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 "_".

notifications_developer_pii_visibility_enabledboolean

When enabled, portal registration notifications include the registering developer's identifying information (such as name and email).

Example response

{
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "sipr_enabled": true,
  "labels": {
    "env": "test"
  }
}

Changes

Changed in 8 of the 75 revisions of this API.331444

Jun 23, 2026bb5e056b7c6d2See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 7, 2026f8b12cdd4a062See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the required property to the response with the status
  response-required-property-added
Oct 30, 2025845120e19d452See the full diff
- ▲
  the request property became not nullable
  request-property-became-not-nullable
- ▲
  the request property became not nullable
  request-property-became-not-nullable
Oct 23, 20258ab3ec3ed3011See the full diff
- ●
  added the new type enum value to the /////// response property for the response status
  response-property-enum-value-added
Aug 22, 20253c0154b2053a1110See the full diff
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /////// became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property became nullable
  request-property-became-nullable
- ○
  the request property default value true was added
  request-property-default-value-added
- ○
  the request property default value false was added
  request-property-default-value-added
- ○
  the request property default value false was added
  request-property-default-value-added
- ○
  the request property default value false was added
  request-property-default-value-added
- ○
  the response's property default value true was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
- ○
  the response's property default value false was added for the status
  response-property-default-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 20256333a0d3b0952128See the full diff
- ▲
  the request's body type changed from no type to object
  request-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ●
  removed subschema #2 from the request body allOf list
  request-body-all-of-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  removed subschema #2 from the response body allOf list for the response status
  response-body-all-of-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 202576b0fefddb0d18121See the full diff
- ▲
  added subschema #2 to the request body allOf list
  request-body-all-of-added
- ▲
  the request's body type changed from object to no type
  request-body-type-changed
- ▲
  the response's body type changed from object to no type for status
  response-body-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added subschema #2 to the response body allOf list for the response status
  response-body-all-of-added
Jul 1, 20259a3d26a000881See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history