---
title: "Get a Portal"
url: "https://nov18-dev.movespot.fyi/apis/internal-portal-1/versions/6cf3dd19-2471-4683-ab50-f062b4345eaa/operations/get-portal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-portal-1/versions/6cf3dd19-2471-4683-ab50-f062b4345eaa.md

# Get a Portal

`GET` `/internal/portals/{portalId}`

Operation ID: `get-portal`

Returns a raw database representation of the portal.

## Path parameters

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

## Responses

- `200` - A raw database portal
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal Portal
  version: 1.0.2
servers:
  - url: http://konnect-api.konnect.svc.cluster.local:300/v0
    description: Konnect cluster
paths:
  /internal/portals/{portalId}:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    get:
      operationId: get-portal
      summary: Get a Portal
      description: Returns a raw database representation of the portal.
      responses:
        "200":
          $ref: "#/components/responses/GetPortal"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - portal
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  responses:
    GetPortal:
      description: A raw database portal
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Portal"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    Portal:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        display_name:
          type: string
        uri:
          type: string
        custom_domain:
          type: string
        is_domain_verified:
          type: boolean
        logo:
          type: string
        logo_filename:
          type: string
        favicon:
          type: string
        favicon_filename:
          type: string
        is_public:
          type: boolean
        authentication_enabled:
          type: boolean
        default_api_visibility:
          $ref: "#/components/schemas/Visibility"
        default_page_visibility:
          $ref: "#/components/schemas/Visibility"
        auto_approve_developers:
          type: boolean
        auto_approve_applications:
          type: boolean
        rbac_enabled:
          type: boolean
        config:
          type: object
          additionalProperties: true
        version:
          type: string
        customization:
          $ref: "#/components/schemas/PortalCustomization"
        labels:
          $ref: "#/components/schemas/Labels"
        description:
          type: string
        default_application_auth_strategy:
          $ref: "#/components/schemas/NullableAuthStrategy"
        sipr_enabled:
          $ref: "#/components/schemas/SourceIPEnabled"
      additionalProperties: true
      required:
        - id
        - default_application_auth_strategy
        - name
        - uri
        - labels
        - version
    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
    Visibility:
      type: string
      enum:
        - public
        - private
    PortalCustomization:
      description: The custom settings of this portal
      type: object
      properties:
        theme:
          type: object
          additionalProperties: false
          properties:
            name:
              type: string
              nullable: false
            mode:
              type: string
              enum:
                - light
                - dark
                - system
            colors:
              type: object
              additionalProperties: false
              properties:
                primary:
                  type: string
                  example: "#000000"
                  nullable: false
                  pattern: ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
                  x-validation-message: must be a valid hex color value
        layout:
          type: string
          nullable: false
        css:
          type: string
          nullable: true
        menu:
          type: object
          additionalProperties: false
          properties:
            main:
              type: array
              items:
                $ref: "#/components/schemas/PortalMenuItem"
            footer_sections:
              type: array
              items:
                $ref: "#/components/schemas/PortalFooterMenuSection"
            footer_bottom:
              type: array
              items:
                $ref: "#/components/schemas/PortalMenuItem"
        spec_renderer:
          type: object
          additionalProperties: false
          properties:
            try_it_ui:
              description: Enable in-browser testing for your APIs. All linked gateways must
                have the CORS plugin configured.
              type: boolean
              default: true
            try_it_insomnia:
              description: Enables users to open API specifications in Insomnia to explore and
                send requests with the native client. Only public API
                specifications are supported.
              type: boolean
              default: true
            infinite_scroll:
              description: Display the full spec on a single, scrollable page. If disabled,
                documentation, endpoints, and schemas appear on separate pages.
              type: boolean
              default: true
            show_schemas:
              description: Control whether schemas are visible in your API specs. When
                enabled, schemas appear in the side navigation below the
                endpoints.
              type: boolean
              default: true
            hide_internal:
              description: Manage visibility of internal endpoints and models.
              type: boolean
              default: false
            hide_deprecated:
              description: Manage visibility of deprecated endpoints and models.
              type: boolean
              default: false
            allow_custom_server_urls:
              description: Let users define a custom server URL for endpoints. This will be
                used to generate code snippets and to test the API. The URL is
                client-side only and is not saved.
              type: boolean
              default: true
        robots:
          type: string
          nullable: true
      additionalProperties: false
      title: PortalCustomization
    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
    NullableAuthStrategy:
      allOf:
        - $ref: "#/components/schemas/BaseAuthStrategy"
      nullable: true
    SourceIPEnabled:
      description: Whether ip allow list is enabled for the organization.
      type: boolean
      example: true
      default: false
    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
    PortalMenuItem:
      type: object
      properties:
        path:
          description: The absolute path of a page in a portal with a leading slash.
          type: string
          example: /about/company
          maxLength: 512
        title:
          description: The link display text
          type: string
          example: My Page
        visibility:
          description: Whether a menu item is public or private. Private menu items are
            only accessible to authenticated users.
          type: string
          example: public
          enum:
            - public
            - private
        external:
          description: When clicked, open the link in a new window
          type: boolean
      additionalProperties: false
      required:
        - path
        - title
        - visibility
        - external
    PortalFooterMenuSection:
      type: object
      properties:
        title:
          description: The footer menu section title
          type: string
          maxLength: 512
        items:
          type: array
          items:
            $ref: "#/components/schemas/PortalMenuItem"
      additionalProperties: false
      required:
        - title
        - items
    BaseAuthStrategy:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        display_name:
          type: string
        strategy_type:
          type: string
        configs:
          type: object
        labels:
          $ref: "#/components/schemas/Labels"
        dcr_provider:
          $ref: "#/components/schemas/NullableDcrProvider"
      required:
        - id
        - name
        - display_name
        - strategy_type
        - dcr_provider
        - configs
        - labels
    NullableDcrProvider:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        provider_type:
          type: string
        issuer:
          type: string
        dcr_config:
          type: object
        labels:
          $ref: "#/components/schemas/Labels"
      nullable: true
      required:
        - id
        - name
        - provider_type
        - issuer
        - dcr_config
        - labels
  examples:
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
