play_circle
Get started
lightbulb
About
Gloo Gateway overview
Architecture
Custom resources
Policies
Policy overview
RouteOption
ListenerOption
HTTPListenerOption
VirtualHostOption
Resource validation
Overview
Enable resource validation
Test resources
settings
Installation options
Helm
Airgap environment
Argo CD
Amazon EKS add-on
Install the glooctl CLI
FIPS images
Licensing
login
Gateway setup
Default gateway proxy setup
Customize the default setup
Distribute gateways (beta)
Deployment patterns
Simple ingress
Ingress with AWS ELBs
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)
Listeners
Overview
HTTP
HTTPS
Mutual TLS (mTLS)
SNI
TCP
TLS passthrough
Additional TLS settings
Gloo Gateway mTLS mode
arrow_split
Traffic management
Destination types
Kubernetes services
Upstreams
About Upstreams
Static
Kubernetes service
AWS EC2
AWS Lambda
Get started
Access AWS Lambda with a service account
Configure cross-account Lambda access
Google Cloud Platform services
HTTP/2
Virtual destinations
Direct responses
Request matching
Path
Header
HTTP method
Query parameter
Redirects
HTTPS redirect
Host redirect
Path redirects
Rewrites
Host rewrites
Path rewrites
Route delegation
Route delegation overview
Basic example
Delegation via labels
Multiple parents
Multi-level delegation
Header and query match
Policy inheritance
Policy overrides
Buffering
External processing (extProc)
About extProc
Header manipulation
Header control
Request headers
Response headers
Health checks
Gateway health checks
Upstream health checks
HTTP/2
Proxy protocol
Session affinity
Stateful session filter
Consistent hashing
TCP keepalive
Traffic splitting
Transformations
Templating language
Inject response headers
Add multiple values to headers
Decode base64 headers
Use extractors for headers
Add headers to body
Extract query parameters
Update request paths and methods
Create redirect URLs
Change response status
Update response body
Enrich access logs
move_up
Resiliency
Caching
About response caching
Set up caching
Fault injection
Retries
Shadowing
Timeouts
Traffic tapping
encrypted
Security
Access logging
CORS
CSRF
Data loss prevention (DLP)
External authentication and authorization
Basic auth
API keys
LDAP
OAuth
About OAuth
Auth0
Google
Keycloak
Microsoft
Okta
More OAuth features
OPA
About
OPA with Rego rules in config maps
OPA server as a sidecar
Bring your own OPA server
Passthrough auth
HTTP
gRPC
JWT
Overview
Gateway-level JWT policy
Route-level JWT policy
Provider example
Rate limiting
Global rate limiting
Envoy API
Set-style API
Local rate limiting
About local rate limiting
HTTP
Upstream TLS
Web Application Firewall (WAF)
cognition
AI Gateway
About Gloo AI Gateway
Tutorials
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
Guides
Cloud LLM providers
Authenticate to the LLM
Streaming
Failover
Function calling
Integrations
Langchain
LlamaIndex
Guardrail Webhook API
Advanced guardrails
Guardrail Webhook API
screen_share
Portal
About Gloo Portal
Portal architecture
Tutorials
Set up Gloo Portal
Create API products
Create a portal
Cleanup
Guides
Manage Portal APIs
Create ApiDocs
Secure Portal APIs
Security options
Set up an IdP
Set up AuthZ with PortalGroups
Set up a portal frontend
Build the frontend app
Set up a secure login
Manage API subscriptions
Set up credential management for APIs
OAuth
API keys
Set up rate limits for APIs
Use the frontend
Create teams and apps
Create API credentials
View and test APIs
Operations
Upgrade
Portal database
Portal Server API
grid_view
Integrations
Amazon EKS add-on
Argo Rollouts
AWS ELBs
ExternalDNS and cert-manager
Istio service mesh
query_stats
Observability
Gloo UI
Set up the UI
Explore the UI
Review insights
Expose the UI via HTTPS
Gateway metrics
settings
Operations
Debug your setup
Upgrade
Uninstall
Troubleshoot
Requests
Portal
AI Gateway
import_contacts
Reference
Version support
API
DirectResponse
GatewayParameters
Other APIs
Helm value reference
Open source
Enterprise Edition
CLI reference
glooctl check
glooctl debug
glooctl debug yaml
glooctl install gateway
glooctl install gateway enterprise
glooctl uninstall
glooctl upgrade
Changelog
Release notes
Open source
Enterprise
Contribution guidelines
Open Source Attribution
Port reference
Security posture
Security updates
CVE lifecycle handling
Open source
Enterprise
handshake
Get help and support
About Solo Support
Submit a request
menu
search
Search
1.20.x
2.0.x (latest)
1.20.x
1.19.x
1.18.x
1.17.x
GitHub
Twitter / X
Enable dark mode
Enable light mode
to navigate
to select
to close
cancel
Home
Portal
Portal Server API
On this page
Table of Contents
Portal Server API
OpenAPI reference docs for the backend portal server that serves your developer portals.