---
title: "Get a Portal"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e/operations/get-portal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-3/versions/209d0e93-97b5-4dd3-a5a4-172ba6d8a51e.md

# Get a Portal

`GET` `/portals/{portalId}`

Operation ID: `get-portal`

Returns the configuration for a single developer portal, including the current visibility, access, and domain settings.

## Path parameters

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

## Responses

- `200` - Details about a portal.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /portals/{portalId}:
    parameters:
      - name: portalId
        in: path
        description: ID of the portal.
        required: true
        schema:
          type: string
          format: uuid
    get:
      operationId: get-portal
      summary: Get a Portal
      description: Returns the configuration for a single developer portal, including
        the current visibility, access, and domain settings.
      responses:
        "200":
          $ref: "#/components/responses/PortalResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portals
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  responses:
    PortalResponse:
      description: Details about a portal.
      content:
        application/json:
          schema:
            type: object
            properties:
              id:
                $ref: "#/components/schemas/UUID"
              created_at:
                $ref: "#/components/schemas/CreatedAt"
              updated_at:
                $ref: "#/components/schemas/UpdatedAt"
              name:
                description: The name of the portal, used to distinguish it from other portals.
                  Name must be unique.
                type: string
                maxLength: 255
                minLength: 1
              display_name:
                description: The display name of the portal. This value will be the portal's
                  `name` in Portal API.
                type: string
                maxLength: 255
                minLength: 1
                nullable: false
              description:
                description: A description of the portal.
                type: string
                maxLength: 512
                nullable: true
              authentication_enabled:
                description: Whether the portal supports developer authentication. If disabled,
                  developers cannot register for accounts or create
                  applications.
                type: boolean
                default: true
              rbac_enabled:
                description: 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.
                type: boolean
                default: false
              sipr_enabled:
                description: Whether ip allow list is enabled for the portal.
                type: boolean
                example: true
                default: false
              default_api_visibility:
                description: 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.
                type: string
                enum:
                  - public
                  - private
              default_page_visibility:
                description: 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.
                type: string
                enum:
                  - public
                  - private
              default_application_auth_strategy_id:
                description: 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.
                type: string
                format: uuid
                nullable: true
              auto_approve_developers:
                description: Whether developer account registrations will be automatically
                  approved, or if they will be set to pending until approved by
                  an admin.
                type: boolean
                default: false
              auto_approve_applications:
                description: 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.
                type: boolean
                default: false
              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
              canonical_domain:
                description: The canonical domain of the developer portal
                type: string
                format: hostname
                nullable: false
                readOnly: true
              labels:
                $ref: "#/components/schemas/Labels"
            additionalProperties: false
            required:
              - id
              - name
              - display_name
              - description
              - authentication_enabled
              - rbac_enabled
              - sipr_enabled
              - default_api_visibility
              - default_page_visibility
              - default_application_auth_strategy_id
              - auto_approve_applications
              - auto_approve_developers
              - default_domain
              - canonical_domain
              - updated_at
              - created_at
            title: Portal
          examples:
            Example 1:
              $ref: "#/components/examples/PortalExample1"
    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"
  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
    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
    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
    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
  examples:
    PortalExample1:
      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
        authentication_enabled: false
        rbac_enabled: true
        sipr_enabled: false
        default_api_visibility: private
        default_page_visibility: private
        default_application_auth_strategy_id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        auto_approve_applications: false
        auto_approve_developers: true
        canonical_domain: api.example.com
    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...'`
```
