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

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

# Portal

## 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
components:
  schemas:
    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
    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
    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
    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
```
