• Set up Gloo Mesh Gateway
    • Deploy sample apps
    • Set up routing for sample apps
    • Apply a policy and explore the UI
      • What is an API Gateway?
      • Overview and benefits
        • Component architecture
        • Networking architecture
        • Relay architecture
      • API concepts
        • Standalone gateway
        • Service mesh
        • Apply policies
        • Import and export policies
        • Supported policies in Gloo Mesh Gateway
      • Install the meshctl CLI
      • Licensing
      • System requirements
      • Installation options
      • Install with Helm
      • Install in a multicluster setup
      • Verify Helm charts
      • Best practices for production
        • About backing databases
        • External auth server
        • Gloo UI
        • Management server
        • Portal server
        • Rate limiter
        • Istio certificates
          • Setup options
          • Certificate rotation overview
          • Insecure setup
            • Self-signed server certificate
            • BYO server certificate
            • Self-signed server certificate with managed client certificates
            • BYO server certificate with managed client certificate
              • OpenSSL
              • AWS
              • Vault
      • Control user access to Gloo resources
      • High availability and disaster recovery
        • Set up multitenancy with workspaces
          • Overview
          • Workspace configuration
          • Import and export resources across workspaces
          • Persona-driven workspace setup
          • Workspaces for gateway tenancy
        • Manually deploy gateways
        • Upgrade gateways
        • Switch from unmanaged to managed gateways
    • Upgrade
    • Uninstall
    • Listener overview
    • HTTP
    • Simple HTTPS/TLS
    • Mutual TLS (mTLS)
    • TLS passthrough
    • TCP passthrough
    • Multiple hosts on one listener (SNI)
      • Routing overview
      • Intra-cluster routing
      • Multicluster routing
      • External service routing
      • Federated services
        • Route table delegation
        • Route label inheritance
        • Route matcher inheritance
        • Route policy attachment
        • Route table failure modes
      • URI path matching
      • Header matching
      • Query parameter matching
      • HTTP method matching
      • Intra-cluster routing
      • Multicluster routing
      • External services
      • Additional route settings
    • Direct response
    • Redirects and rewrites
    • Route delegation
    • Header manipulation
    • HTTP buffer filter
    • Load balancing and consistent hashing
    • Mirroring
    • Proxy protocol
    • Transformation
      • Gloo components
      • Network traffic
      • User access
      • Applications
      • Underlying infrastructure
    • Client TLS
    • CORS
    • CSRF
    • Data loss prevention (DLP)
    • Deny all HTTP requests
      • About
      • External auth server setup
      • Basic external auth policy
      • API keys
      • LDAP
        • API key and OPA
        • About OAuth
        • Google
        • Hydra
        • Keycloak
        • Microsoft
          • Okta access token example
          • Okta authorization code example
        • More OAuth features
        • About
        • OPA with Rego rules in config maps
        • OPA server as a sidecar
        • Bring your own OPA server
      • Passthrough
      • About
      • Basic JWT example
      • Multiple JWT policies
      • Multiple JWT providers
      • JWT claim- and scope-based auth
      • JWT, ext auth, and transformation policies
      • More JWT examples
      • About
      • Rate limit server setup
      • Basic rate limit policy
      • More rate limit policy examples
    • Web application firewall (WAF)
    • Active healthcheck
    • Connection pools for HTTP
    • Connection pools for TCP
    • Fault injection
    • Listener connection
    • Outlier detection
    • Retry and timeout
    • About the telemetry pipeline
      • Overview
        • Overview
        • Explore the UI
        • Configure the UI for HTTPS
        • Connect the Gloo UI to OpenShift Prometheus
          • Overview
          • External auth with Google
          • External auth with Dex
          • External auth with Okta
          • OIDC settings in Helm
          • RBAC for resources in the UI
        • Overview
        • Sample PromQL queries
        • Metrics
        • Alerts
        • Customization options
        • Overview
        • Set up and access Grafana
        • Import the operations dashboard
        • Import the Portal analytics dashboard
        • Import the OPA dashboard
      • Jaeger
      • Istio access logs
      • Add Istio request traces
      • Collect compute instance metadata
      • Forward metrics to Datadog
      • Forward metrics to OpenShift
    • About
    • Architecture
      • Set up Gloo Portal
      • Create API products
      • Create a portal
      • Protect your APIs
      • Secure access to the portal
      • Cleanup
        • Create ApiDocs
        • Create API products
        • Rewrite API paths
        • Version your APIs
        • Apply policies to APIs
      • Usage plans
        • About external auth
        • API keys
        • OAuth
        • OAuth for multiple API products
      • Rate limits for APIs
      • Backend portal configuration
      • Portal AuthN and AuthZ
        • Sample React app
          • About Backstage
          • Backstage backend plugin
          • Backstage frontend plugin
      • End user guide
      • Install Portal
      • Install Portal with analytics
      • Upgrade or uninstall Portal
    • Portal API
    • About
    • Get started
    • Configure AWS IAM permissions
    • Provide AWS account and Lambda details
    • Set up routing
    • Manage multitenancy
    • Request and response payloads
      • Gloo Mesh Gateway versions
        • Overview
        • Supported Solo distributions of Istio
      • Open Source attribution
      • Feature gates
      • Release notes
      • Gloo Mesh Gateway changelog
      • Solo distribution of Istio changelog
      • Overview
      • AccessLogPolicy
      • AccessPolicy
      • ActiveHealthCheckPolicy
      • AdaptiveRequestConcurrencyPolicy
      • ApiDoc
      • ApiSchemaDiscovery
      • ApprovalState
      • AuthConfig
      • CaOptions
      • Clientmode
      • ClientTlsPolicy
      • CloudProvider
      • CloudProviderOptions
      • CloudResources
      • ConnectionPolicy
      • Core
      • CorsPolicy
      • CsrfPolicy
      • Cue
      • Dashboard
      • DlpPolicy
      • EnforcementLayers
      • ExtAuthPolicy
      • ExtAuthServer
      • ExternalEndpoint
      • ExternalService
      • ExternalWorkload
      • FailoverPolicy
      • FaultInjectionPolicy
      • GatewayLifecycleManager
      • HeaderManipulation
      • HttpBufferPolicy
      • HttpMatchers
      • InsightsConfig
      • InternalAdmin
      • IstioLifecycleManager
      • IstioOperator
      • JwtPolicy
      • K8SReports
      • Keepalive
      • KubernetesCluster
      • ListenerConnectionPolicy
      • LoadBalancerPolicy
      • Locality
      • MirrorPolicy
      • OutlierDetectionPolicy
      • Phase
      • Port
      • Portal
      • PortalGroup
      • ProxyProtocolPolicy
      • Ratelimit
      • RatelimitClientConfig
      • RatelimitPolicy
      • RatelimitServerConfig
      • RatelimitServerSettings
      • Ref
      • References
      • RetryTimeoutPolicy
      • RootTrustPolicy
      • RouteTable
      • Selectors
      • SoloKit
      • Status
      • StringMatch
      • TcpMatchers
      • TlsMatchers
      • TransformationPolicy
      • TrimProxyConfigPolicy
      • VaultCa
      • VirtualDestination
      • VirtualGateway
      • WafPolicy
      • Workspace
      • WorkspaceSettings
      • Helm chart overview
      • Gloo Platform
      • Gloo Platform CRDs
      • meshctl
      • meshctl check
      • meshctl check server
      • meshctl cluster
      • meshctl cluster deregister
      • meshctl cluster list
      • meshctl cluster register
      • meshctl dashboard
      • meshctl debug
      • meshctl debug report
      • meshctl experimental
      • meshctl experimental dump-reports
      • meshctl experimental switch-active
      • meshctl external-workload
      • meshctl external-workload bug-report
      • meshctl external-workload generate-token
      • meshctl external-workload install
      • meshctl external-workload onboard
      • meshctl external-workload uninstall
      • meshctl install
      • meshctl license
      • meshctl license check
      • meshctl logs
      • meshctl migrate
      • meshctl migrate helm
      • meshctl migrate helm-values
      • meshctl precheck
      • meshctl proxy
      • meshctl uninstall
      • meshctl version
      • CVE lifecycle handling
      • Security and CVE scan results
    • Gloo component permissions
    • General debugging
      • Management server and relay connection
      • Add-ons
      • Agent
      • Custom resources
      • Observability pipeline
      • Policies
      • Redis
      • Routes
      • UI graph
      • Istio debugging
      • Istio and gateway lifecycle manager
      • ELB health checks in AWS fail
      • Istio gateway installation times out
      • Bookinfo apps pending
      • Portal server
      • API usage analytics
      • Frontend app
      • OAuth for portal
      • Failed to watch a portal resource
      • Try-it-out feature in the developer portal
    • About Solo Support
    • Submit a request
    • Add support information
    • main
    • 2.7 (latest)
    • 2.6
    • 2.5
    • 2.4
    • GitHub
    • Twitter / X
  • to navigate
  • to select
  • to close
    • Home
    • Portal
    • Portal API
    On this page

    This doc set is for users of the Gloo Mesh Gateway product to set up an Istio ingress gateway. For users of the Gloo Gateway product to set up an ingress gateway with the Kubernetes Gateway API instead, see the Gloo Gateway docs.

    Portal API

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

    Solo.io copyright 2025