Sign in
Portals

Update Portal

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

patch/v2/portals/{portalId}#classic

Request body

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

The description of the portal.

is_publicboolean nullable

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 nullable

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 nullable

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 nullable

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

custom_domainstring hostname nullable

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

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.

default_application_auth_strategy_idstring uuid nullable

Default strategy ID applied on applications for the 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 "_".

Example request

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

Response

Details about the portal being updated.

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

The description of the portal.

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

is_publicboolean required

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 required

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 required

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 required

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

custom_domainstring hostname nullable 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 hostname nullable 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 uuid nullable

Default strategy ID applied on applications for the 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 "_".

application_countnumber required

Number of applications created in the portal.

developer_countnumber required

Number of developers using the portal.

published_product_countnumber required

Number of api products published to the portal

Example response

{
  "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-02-07T17:46:57.52Z",
  "updated_at": "2022-10-08T17:00:00.52Z",
  "name": "Portal A",
  "display_name": "Developer Portal A",
  "description": "The Portal A",
  "default_domain": "123455678abcd.us.portal.konghq.com",
  "is_public": false,
  "rbac_enabled": true,
  "auto_approve_applications": false,
  "auto_approve_developers": true,
  "custom_domain": "api.example.com",
  "custom_client_domain": "portal.example.com",
  "application_count": 0,
  "developer_count": 0,
  "published_product_count": 0
}

Changes

Changed in 3 of the 52 revisions of this API.915

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the /////// response property for the response status

      response-property-enum-value-added

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

  • 96118a9cd7f494See 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 request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

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

  • ab1a51b761441See the full diff
    • ○

      endpoint added

      endpoint-added

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