• play_circle Get started
    • Gloo Gateway overview
    • Architecture
    • Custom resources
      • Policy overview
      • RouteOption
      • ListenerOption
      • HTTPListenerOption
      • VirtualHostOption
      • Overview
      • Enable resource validation
      • Test resources
    • Helm
    • Airgap environment
    • Argo CD
    • Amazon EKS add-on
    • Install the glooctl CLI
    • Licensing
    • Default gateway proxy setup
    • Customize the default setup
        • Simple ingress
          • Network Load Balancer (NLB)
          • Application Load Balancer (ALB)
        • Ingress to ambient mesh
        • Ingress to Istio sidecar mesh
        • Ingress to Istio sidecar mesh with virtual destinations (GME)
        • Self-managed gateways (BYO)
        • Gloo Gateway as a waypoint proxy
      • HTTP
      • HTTPS
      • TCP
      • Kubernetes services
        • About Upstreams
        • Static
        • Kubernetes service
        • AWS EC2
          • Get started
          • Access AWS Lambda with a service account
          • Configure cross-account Lambda access
        • Google Cloud Platform services
        • HTTP/2
      • Virtual destinations
    • Direct responses
      • Path
      • Header
      • HTTP method
      • Query parameter
      • HTTPS redirect
      • Host redirect
      • Path redirects
      • Host rewrites
      • Path rewrites
      • Route delegation overview
      • Basic example
      • Delegation via labels
      • Multiple parents
      • Multi-level delegation
      • Header and query match
      • Policy inheritance
      • Policy overrides
    • Buffering
      • About extProc
      • Header manipulation
      • Request headers
      • Response headers
      • Gateway health checks
      • Upstream health checks
      • Stateful session filter
      • Consistent hashing
    • TCP keepalive
    • Proxy protocol
      • Inject response headers
      • Decode base64 headers
      • Extract query parameters
      • Update request paths and methods
      • Add headers to body
    • Traffic splitting
      • About response caching
      • Set up caching
    • Fault injection
    • Retries
    • Shadowing
    • Timeouts
    • Traffic tapping
    • Access logging
    • CORS
    • CSRF
    • Data loss prevention (DLP)
      • Basic auth
      • API keys
      • LDAP
        • About OAuth
        • Auth0
        • Google
        • Keycloak
        • Microsoft
        • Okta
        • More OAuth features
        • About
        • OPA with Rego rules in config maps
        • OPA server as a sidecar
        • Bring your own OPA server
        • HTTP
        • gRPC
      • Overview
      • Gateway-level JWT policy
      • Route-level JWT policy
      • Provider example
        • Envoy API
        • Set-style API
        • About local rate limiting
        • HTTP
    • Web Application Firewall (WAF)
    • About Gloo AI Gateway
      • Set up Gloo AI Gateway
      • Authenticate with API keys
      • Control access
      • Observability
      • Rate limit requests
      • Manage and enrich prompts
      • Set up prompt guards
      • Retrieval augmented generation (RAG)
      • Semantic caching
      • Cleanup
      • Authenticate to the LLM
      • Failover
      • Function calling
      • Langchain
      • LlamaIndex
    • About Gloo Portal
    • Portal architecture
      • Set up Gloo Portal
      • Create API products
      • Create a portal
      • Cleanup
        • Create ApiDocs
        • Security options
        • Set up an IdP
        • Set up AuthZ with PortalGroups
        • Build the frontend app
        • Set up a secure login
        • Manage API subscriptions
          • OAuth
          • API keys
        • Set up rate limits for APIs
        • Create teams and apps
        • Create API credentials
        • View and test APIs
      • Upgrade
      • Portal database
    • Portal Server API
    • Amazon EKS add-on
    • Argo Rollouts
    • AWS ELBs
    • ExternalDNS and cert-manager
    • Istio service mesh
      • Set up the UI
      • Explore the UI
    • Gateway metrics
    • Debug your setup
    • Upgrade
    • Uninstall
      • Requests
      • Portal
      • AI Gateway
    • Version support
      • DirectResponse
      • GatewayParameters
      • Other APIs
      • Open source
      • Enterprise Edition
      • glooctl check
      • glooctl install gateway
      • glooctl install gateway enterprise
      • glooctl uninstall
      • glooctl upgrade
      • Release notes
      • Open source
      • Enterprise
    • Contribution guidelines
    • Open Source Attribution
    • Port reference
    • Security posture
      • CVE lifecycle handling
      • Open source
      • Enterprise
    • About Solo Support
    • Submit a request
    • main
    • 1.18.x (latest)
    • 1.17.x
    • GitHub
    • Twitter / X
  • to navigate
  • to select
  • to close
    • Home
    • Portal
    • Portal Server API
    On this page

    This documentation uses Gloo Gateway proxies with the Kubernetes Gateway API. To use the Edge API instead, click here. Note that some features, such as AI gateways, are not supported with the Edge API.

    Portal Server API

    OpenAPI reference docs for the backend portal server that serves your developer portals.

    info

    To review the OpenAPI specification for the portal server, click this link.

    Solo.io copyright 2025