--- title: "Update Portal" method: PATCH path: "/v2/portals/{portalId}#classic" tags: ["Portals"] --- # Update Portal `PATCH /v2/portals/{portalId}#classic` Updates the configuration for a single portal including the visibility, access, and custom domain settings. ## Request body - V2UpdatePortalRequest - `name` string — The name of the portal, used to distinguish it from other portals. Name must be unique. - `display_name` string — The display name of the portal. This value will be the portal's `name` in Portal API. - `description` string, nullable — The description of the portal. - `is_public` boolean, 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_enabled` boolean, 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_applications` boolean, 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_developers` boolean, nullable — Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. - `custom_domain` string, 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_domain` string, 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_id` string, uuid, nullable — Default strategy ID applied on applications for the portal - `labels` LabelsUpdate, 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 "_". ## Response `200` Details about the portal being updated. - V2UpdatePortalResponse - `id` string, uuid, required — Contains a unique identifier used for this resource. - `created_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date. - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date. - `name` string, required — The name of the portal, used to distinguish it from other portals. Name must be unique. - `display_name` string, required — The display name of the portal. This value will be the portal's `name` in Portal API. - `description` string, nullable, required — The description of the portal. - `default_domain` string, 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_public` boolean, 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_enabled` boolean, 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_applications` boolean, 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_developers` boolean, required — Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin. - `custom_domain` string, 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_domain` string, 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_id` string, uuid, nullable — Default strategy ID applied on applications for the portal - `labels` Labels — 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_count` number, required — Number of applications created in the portal. - `developer_count` number, required — Number of developers using the portal. - `published_product_count` number, required — Number of api products published to the portal ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `409` — Conflict --- [API](https://skmtc.net/kong/apis/konnect-api.md) · [All operations](https://skmtc.net/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api/revisions/06734a9c491f/schema)