---
title: "Update Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/operations/update-portal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# Update Portal

`PATCH` `/portals/{portalId}`

Operation ID: `update-portal`

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

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Details about the portal being updated.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `409` - Conflict

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /portals/{portalId}:
    parameters:
      - name: portalId
        in: path
        description: ID of the portal.
        required: true
        schema:
          type: string
          format: uuid
    patch:
      operationId: update-portal
      summary: Update Portal
      description: Updates the configuration for a single portal including the
        visibility, access, and custom domain settings.
      requestBody:
        $ref: "#/components/requestBodies/UpdatePortal"
      responses:
        "200":
          $ref: "#/components/responses/UpdatePortal"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                UpdatePortalBadRequestExample1:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample1"
                UpdatePortalBadRequestExample2:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample2"
                UpdatePortalBadRequestExample3:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample3"
                UpdatePortalBadRequestExample4:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample4"
                UpdatePortalBadRequestExample5:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample5"
                UpdatePortalBadRequestExample6:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample6"
                UpdatePortalBadRequestExample7:
                  $ref: "#/components/examples/UpdatePortalBadRequestExample7"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/Conflict"
      tags:
        - Portals
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  requestBodies:
    UpdatePortal:
      description: Update a portal's settings.
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/UpdatePortalRequest"
          examples:
            Example 1:
              $ref: "#/components/examples/UpdatePortalExample1"
            Public Portal:
              $ref: "#/components/examples/UpdatePortalExamplePublic"
            Enable RBAC:
              $ref: "#/components/examples/UpdatePortalExampleRbacEnabled"
            Auto Approve Settings:
              $ref: "#/components/examples/UpdatePortalExampleAutoApprove"
            Custom Domains:
              $ref: "#/components/examples/UpdatePortalExampleCustomDomains"
  responses:
    UpdatePortal:
      description: Details about the portal being updated.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/UpdatePortalResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/UpdatePortalResponseExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
  schemas:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UpdatePortalRequest:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/PortalName"
        display_name:
          $ref: "#/components/schemas/PortalDisplayName"
        description:
          $ref: "#/components/schemas/PortalDescription"
        is_public:
          description: Whether the portal catalog can be accessed publicly without any
            developer authentication. Developer accounts and applications cannot
            be created if the portal is public.
          type: boolean
        rbac_enabled:
          description: 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.
          type: boolean
        auto_approve_applications:
          description: 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.
          type: boolean
        auto_approve_developers:
          description: Whether the developer account registrations will be automatically
            approved, or if they will be set to pending until approved by an
            admin.
          type: boolean
        custom_domain:
          description: 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.
          type: string
          format: hostname
          maxLength: 1024
          nullable: true
        custom_client_domain:
          description: 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.
          type: string
          format: hostname
          maxLength: 1024
          nullable: true
        default_application_auth_strategy_id:
          $ref: "#/components/schemas/DefaultApplicationAuthStratID"
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
      example:
        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
      additionalProperties: false
    UpdatePortalResponse:
      $ref: "#/components/schemas/Portal"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ConflictError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 409
            title:
              example: Conflict
            type:
              example: https://httpstatuses.com/409
            instance:
              example: kong:trace:1234567890
            detail:
              example: Conflict
    PortalName:
      description: The name of the portal, used to distinguish it from other portals.
        Name must be unique.
      type: string
      maxLength: 255
      minLength: 1
    PortalDisplayName:
      description: The display name of the portal. This value will be the portal's
        `name` in Portal API.
      type: string
      maxLength: 255
      minLength: 1
    PortalDescription:
      description: The description of the portal.
      type: string
      maxLength: 512
      nullable: true
    DefaultApplicationAuthStratID:
      description: Default strategy ID applied on applications for the portal
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      nullable: true
    LabelsUpdate:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    Portal:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          $ref: "#/components/schemas/PortalName"
        display_name:
          $ref: "#/components/schemas/PortalDisplayName"
        description:
          $ref: "#/components/schemas/PortalDescription"
        default_domain:
          description: 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``.
          type: string
          format: hostname
          readOnly: true
        is_public:
          description: Whether the portal catalog can be accessed publicly without any
            developer authentication. Developer accounts and applications cannot
            be created if the portal is public.
          type: boolean
        rbac_enabled:
          description: 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.
          type: boolean
        auto_approve_applications:
          description: 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.
          type: boolean
        auto_approve_developers:
          description: Whether the developer account registrations will be automatically
            approved, or if they will be set to pending until approved by an
            admin.
          type: boolean
        custom_domain:
          description: 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.
          type: string
          format: hostname
          nullable: true
        custom_client_domain:
          description: 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.
          type: string
          format: hostname
          nullable: true
        default_application_auth_strategy_id:
          $ref: "#/components/schemas/DefaultApplicationAuthStratID"
        labels:
          $ref: "#/components/schemas/Labels"
        application_count:
          description: Number of applications created in the portal.
          type: number
        developer_count:
          description: Number of developers using the portal.
          type: number
        published_product_count:
          description: Number of api products published to the portal
          type: number
      example:
        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
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - display_name
        - default_domain
        - is_public
        - rbac_enabled
        - auto_approve_applications
        - auto_approve_developers
        - custom_domain
        - custom_client_domain
        - description
        - application_count
        - developer_count
        - published_product_count
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UpdatePortalBadRequestExample1:
      summary: Unknown property
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: my_property
            rule: unknown_property
            reason: '"my_property" is not allowed'
            source: body
    UpdatePortalBadRequestExample2:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: is_public
            rule: is_boolean
            reason: value of "is_public" must be true or false
            source: body
    UpdatePortalBadRequestExample3:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: rbac_enabled
            rule: is_boolean
            reason: value of "rbac_enabled" must be true or false
            source: body
    UpdatePortalBadRequestExample4:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: auto_approve_applications
            rule: is_boolean
            reason: value of "auto_approve_applications" must be true or false
            source: body
    UpdatePortalBadRequestExample5:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: auto_approve_developers
            rule: is_boolean
            reason: value of "auto_approve_developers" must be true or false
            source: body
    UpdatePortalBadRequestExample6:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: custom_domain
            rule: max_length
            reason: value of "custom_domain" must not exceed 1024 characters
            source: body
            maximum: 1024
    UpdatePortalBadRequestExample7:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: custom_client_domain
            rule: max_length
            reason: value of "custom_client_domain" must not exceed 1024 characters
            source: body
            maximum: 1024
    UpdatePortalExample1:
      value:
        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
    UpdatePortalExamplePublic:
      value:
        is_public: true
    UpdatePortalExampleRbacEnabled:
      value:
        rbac_enabled: true
    UpdatePortalExampleAutoApprove:
      value:
        auto_approve_applications: false
        auto_approve_developers: false
    UpdatePortalExampleCustomDomains:
      value:
        custom_domain: api.example.com
        custom_client_domain: portal.example.com
    UpdatePortalResponseExample1:
      value:
        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
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
