Sign in
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 nullable

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

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 required

Whether ip allow list is enabled for the portal.

default_api_visibility'public' | 'private' required

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' required

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 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_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 29 revisions of this API.7447

  • 658ffb748f9522See the full diff
    • ●

      removed the request property mcp_server_enabled

      request-property-removed

    • ●

      removed the optional property mcp_server_enabled from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property ai

      new-optional-request-property

    • ○

      added the optional property ai to the response with the 200 status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5536690850b52See the full diff
    • ○

      added the new optional request property mcp_server_enabled

      new-optional-request-property

    • ○

      added the optional property mcp_server_enabled to the response with the 200 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

  • be4c4e09af622See the full diff
    • ○

      added the new optional request property notifications_developer_pii_visibility_enabled

      new-optional-request-property

    • ○

      added the optional property notifications_developer_pii_visibility_enabled to the response with the 200 status

      response-optional-property-added

  • 55d91b8ceecd2See the full diff
    • ○

      the sipr_enabled request property default value false was added

      request-property-default-value-added

    • ○

      the sipr_enabled response's property default value false was added for the status 200

      response-property-default-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 106b373707f32See the full diff
    • ○

      added the new optional request property sipr_enabled

      new-optional-request-property

    • ○

      added the required property sipr_enabled to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5d2b35832e3f1See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de659See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ○

      the request property name became nullable

      request-property-became-nullable

    • ○

      the authentication_enabled request property default value true was added

      request-property-default-value-added

    • ○

      the auto_approve_applications request property default value false was added

      request-property-default-value-added

    • ○

      the auto_approve_developers request property default value false was added

      request-property-default-value-added

    • ○

      the rbac_enabled request property default value false was added

      request-property-default-value-added

    • ○

      the authentication_enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the auto_approve_applications response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the auto_approve_developers response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      the rbac_enabled response's property default value false was added for the status 200

      response-property-default-value-added

  • d12b4edfb67b2128See the full diff
    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ●

      removed Portal subschema #2 from the request body allOf list

      request-body-all-of-removed

    • ○

      added the new optional request property authentication_enabled

      new-optional-request-property

    • ○

      added the new optional request property auto_approve_applications

      new-optional-request-property

    • ○

      added the new optional request property auto_approve_developers

      new-optional-request-property

    • ○

      added the new optional request property default_api_visibility

      new-optional-request-property

    • ○

      added the new optional request property default_application_auth_strategy_id

      new-optional-request-property

    • ○

      added the new optional request property default_page_visibility

      new-optional-request-property

    • ○

      added the new optional request property description

      new-optional-request-property

    • ○

      added the new optional request property display_name

      new-optional-request-property

    • ○

      added the new optional request property labels

      new-optional-request-property

    • ○

      added the new optional request property name

      new-optional-request-property

    • ○

      added the new optional request property rbac_enabled

      new-optional-request-property

    • ○

      removed Portal subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added the optional property labels to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property authentication_enabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property auto_approve_applications to the response with the 200 status

      response-required-property-added

    • ○

      added the required property auto_approve_developers to the response with the 200 status

      response-required-property-added

    • ○

      added the required property canonical_domain to the response with the 200 status

      response-required-property-added

    • ○

      added the required property created_at to the response with the 200 status

      response-required-property-added

    • ○

      added the required property default_api_visibility to the response with the 200 status

      response-required-property-added

    • ○

      added the required property default_application_auth_strategy_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property default_domain to the response with the 200 status

      response-required-property-added

    • ○

      added the required property default_page_visibility to the response with the 200 status

      response-required-property-added

    • ○

      added the required property description to the response with the 200 status

      response-required-property-added

    • ○

      added the required property display_name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property rbac_enabled to the response with the 200 status

      response-required-property-added

    • ○

      added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog