• Set up Gloo Mesh
      • Deploy sample apps
      • Set up routing for sample apps
      • Apply a policy and explore the UI
      • Tutorial: Federate clusters and isolate workloads for multitenancy
      • Set up Gloo Mesh
      • Deploy sample apps
      • Apply a policy and explore the UI
      • Overview and benefits
        • Component architecture
        • Networking architecture
        • Relay architecture
      • API concepts
        • Apply policies
        • Import and export policies
        • Supported policies in Gloo Mesh Enterprise
      • Personas
      • Resource validation
      • What is a service mesh?
      • What is Istio?
      • Install the meshctl CLI
      • Licensing
      • System requirements
      • Installation options
      • Install with Helm
      • Install with Argo CD
      • Install in air-gapped environments
      • Verify Helm charts
      • Best practices for production
        • About Redis
        • Built-in Redis
        • Local Redis
        • External Redis
          • Istio CA overview
            • Setup options
            • Certificate rotation overview
            • Manage the entire Istio CA lifecycle
            • Manage Istio intermediate CAs
            • Integrate with Vault
            • AWS
          • 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
        • About onboarding external workloads
        • AWS instances
        • Azure instances
        • GCP instances
        • On-prem instances
      • FIPS images
      • High availability and disaster recovery
        • Set up multitenancy with workspaces
          • Overview
          • Workspace configuration
          • Import and export resources across workspaces
          • Workspaces as service discovery boundaries
          • Persona-driven workspace setup
    • Upgrade
    • Uninstall
    • Service mesh options
      • Overview
      • Supported Solo distributions of Istio
      • Install Gloo-managed service meshes
      • Migrate to Gloo-managed service meshes
      • Upgrade Gloo Operator-managed service meshes
      • Best practices for Istio in prod
      • Install Istio service meshes with Helm
      • Upgrade Istio service meshes with Helm
    • Install Istio with EKS add-on
    • Install Istio with AKS Extension
    • Add apps to the service mesh
    • Route across clusters with east-west gateways
    • Expose apps with an ingress gateway
    • Upgrade with the Istio lifecycle manager (legacy)
      • Routing overview
      • Intra-mesh routing
      • Multicluster routing
      • Routing to external services
      • 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
      • Route within or across clusters
        • Route to an external service directly
        • Create internal DNS entries for external endpoints
        • Block egress traffic with an egress gateway
      • Additional route settings
    • Direct response
    • Redirects and rewrites
    • Route delegation
    • Header manipulation
    • Load balancing and consistent hashing
    • Mirroring
    • Transformation
      • Security overview
      • Gloo components
      • Service mesh traffic
      • User access
      • Applications
      • Underlying infrastructure
    • Access policy
    • CORS
      • About
      • External auth server setup
      • Basic external auth policy
      • API keys
      • LDAP
        • About
        • OPA with Rego rules in config maps
        • OPA server as a sidecar
        • Bring your own OPA server
        • API key and OPA
      • About
      • JWT for destinations
      • JWT for mesh routes
      • Multiple JWT providers
      • JWT claim- and scope-based auth
      • About
      • Rate limit server setup
      • Basic rate limit policy
      • Multicluster rate limit
      • More rate limit policy examples
    • Adaptive request concurrency
    • Connection pool settings for HTTP
    • Failover
    • Fault injection
    • Outlier detection
    • Retry and timeout
    • TCP connection
      • About
      • Trim proxy config policy
      • Trim proxy in workspace settings
    • About the telemetry pipeline
      • Overview
        • Overview
        • Explore the UI with insights
        • 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
      • Istio insights
        • Overview
        • Sample PromQL queries
        • Metrics
        • Alerts
        • Customization options
        • Overview
        • Set up and access Grafana
        • Import the operations dashboard
        • Import the OPA dashboard
      • Jaeger
      • Istio access logs
      • Add Istio insights
      • Add Istio request traces
      • Collect compute instance metadata
      • Forward metrics to Datadog
      • Forward metrics to OpenShift
      • Enable logs
      • Gloo Mesh Enterprise versions
      • Open Source attribution
      • Feature gates
      • Release notes
      • Gloo Mesh Enterprise changelog
      • Solo distribution of Istio changelog
      • Overview
      • AccessLogPolicy
      • AccessPolicy
      • ActiveHealthCheckPolicy
      • AdaptiveRequestConcurrencyPolicy
      • ApiDoc
      • ApiSchemaDiscovery
      • ApprovalState
      • AuthConfig
      • CaOptions
      • Clientmode
      • ClientTlsPolicy
      • CloudProvider
      • CloudProviderOptions
      • CloudResources
      • Condition
      • ConnectionPolicy
      • Core
      • CorsPolicy
      • CsrfPolicy
      • Dashboard
      • DlpPolicy
      • EnforcementLayers
      • ExtAuthPolicy
      • ExtAuthServer
      • ExternalEndpoint
      • ExternalService
      • ExternalWorkload
      • FailoverPolicy
      • FaultInjectionPolicy
      • GatewayLifecycleManager
      • HeaderManipulation
      • HttpBufferPolicy
      • HttpMatchers
      • InsightsConfig
      • InternalAdmin
      • IstioHelm
      • IstioLifecycleManager
      • IstioOperator
      • JwtPolicy
      • K8SReports
      • Keepalive
      • KubernetesCluster
      • ListenerConnectionPolicy
      • LoadBalancerPolicy
      • Locality
      • MirrorPolicy
      • OutlierDetectionPolicy
      • Phase
      • Port
      • Portal
      • PortalGroup
      • PortalMetadata
      • 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 interop-check
      • meshctl experimental switch-active
      • meshctl experimental validate
      • meshctl experimental validate resources
      • meshctl experimental validate resources clean
      • 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 generate
      • meshctl generate graphql
      • meshctl generate graphql grpc
      • 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 Mesh scalability
    • Gloo component permissions
    • General debugging
      • Management server and relay connection
      • Add-ons
      • Agent
      • Custom resources
      • Observability pipeline
      • Policies
      • Redis
      • Routes
      • UI graph
      • ELB health checks in AWS fail
      • Istio gateway installation times out
      • Istio
      • Istio and gateway lifecycle manager
      • Knative
      • Bookinfo apps pending
      • Ephemeral containers
    • About Solo Support
    • Submit a request
    • Add support information
  • open_in_new Gloo Mesh Gateway
    • main
    • 2.9 (latest)
    • 2.8
    • 2.7
    • 2.6
    • GitHub
    • Twitter / X
  • to navigate
  • to select
  • to close
    • Home
    • Reference
    • API reference
    On this page

    These docs use Gloo Mesh Enterprise APIs to manage your sidecar service mesh. To manage your service mesh with the Kubernetes Gateway API instead, see the Gloo Mesh docs.

    API reference

    Review the API specification for the custom resource definitions (CRDs) that Gloo Mesh Enterprise installs.

    article

    Overview

    Review the API specification for the custom resource definitions (CRDs) that Gloo Mesh Enterprise …

    article

    AccessLogPolicy

    AccessLogPolicy API reference.

    article

    AccessPolicy

    AccessPolicy API reference.

    article

    ActiveHealthCheckPolicy

    ActiveHealthCheckPolicy API reference.

    article

    AdaptiveRequestConcurrencyPolicy

    AdaptiveRequestConcurrencyPolicy API reference.

    article

    ApiDoc

    ApiDoc API reference.

    article

    ApiSchemaDiscovery

    ApiSchemaDiscovery API reference.

    article

    ApprovalState

    ApprovalState API reference.

    article

    AuthConfig

    AuthConfig API reference.

    article

    CaOptions

    CaOptions API reference.

    article

    Clientmode

    Clientmode API reference.

    article

    ClientTlsPolicy

    ClientTlsPolicy API reference.

    article

    CloudProvider

    CloudProvider API reference.

    article

    CloudProviderOptions

    CloudProviderOptions API reference.

    article

    CloudResources

    CloudResources API reference.

    article

    Condition

    Condition API reference.

    article

    ConnectionPolicy

    ConnectionPolicy API reference.

    article

    Core

    Core API reference.

    article

    CorsPolicy

    CorsPolicy API reference.

    article

    CsrfPolicy

    CsrfPolicy API reference.

    article

    Dashboard

    Dashboard API reference.

    article

    DlpPolicy

    DlpPolicy API reference.

    article

    EnforcementLayers

    EnforcementLayers API reference.

    article

    ExtAuthPolicy

    ExtAuthPolicy API reference.

    article

    ExtAuthServer

    ExtAuthServer API reference.

    article

    ExternalEndpoint

    ExternalEndpoint API reference.

    article

    ExternalService

    ExternalService API reference.

    article

    ExternalWorkload

    ExternalWorkload API reference.

    article

    FailoverPolicy

    FailoverPolicy API reference.

    article

    FaultInjectionPolicy

    FaultInjectionPolicy API reference.

    article

    GatewayLifecycleManager

    GatewayLifecycleManager API reference.

    article

    HeaderManipulation

    HeaderManipulation API reference.

    article

    HttpBufferPolicy

    HttpBufferPolicy API reference.

    article

    HttpMatchers

    HttpMatchers API reference.

    article

    InsightsConfig

    InsightsConfig API reference.

    article

    InternalAdmin

    InternalAdmin API reference.

    article

    IstioHelm

    IstioHelm API reference.

    article

    IstioLifecycleManager

    IstioLifecycleManager API reference.

    article

    IstioOperator

    IstioOperator API reference.

    article

    JwtPolicy

    JwtPolicy API reference.

    article

    K8SReports

    K8SReports API reference.

    article

    Keepalive

    Keepalive API reference.

    article

    KubernetesCluster

    KubernetesCluster API reference.

    article

    ListenerConnectionPolicy

    ListenerConnectionPolicy API reference.

    article

    LoadBalancerPolicy

    LoadBalancerPolicy API reference.

    article

    Locality

    Locality API reference.

    article

    MirrorPolicy

    MirrorPolicy API reference.

    article

    OutlierDetectionPolicy

    OutlierDetectionPolicy API reference.

    article

    Phase

    Phase API reference.

    article

    Port

    Port API reference.

    article

    Portal

    Portal API reference.

    article

    PortalGroup

    PortalGroup API reference.

    article

    PortalMetadata

    PortalMetadata API reference.

    article

    ProxyProtocolPolicy

    ProxyProtocolPolicy API reference.

    article

    Ratelimit

    Ratelimit API reference.

    article

    RatelimitClientConfig

    RatelimitClientConfig API reference.

    article

    RatelimitPolicy

    RatelimitPolicy API reference.

    article

    RatelimitServerConfig

    RatelimitServerConfig API reference.

    article

    RatelimitServerSettings

    RatelimitServerSettings API reference.

    article

    Ref

    Ref API reference.

    article

    References

    References API reference.

    article

    RetryTimeoutPolicy

    RetryTimeoutPolicy API reference.

    article

    RootTrustPolicy

    RootTrustPolicy API reference.

    article

    RouteTable

    RouteTable API reference.

    article

    Selectors

    Selectors API reference.

    article

    SoloKit

    SoloKit API reference.

    article

    Status

    Status API reference.

    article

    StringMatch

    StringMatch API reference.

    article

    TcpMatchers

    TcpMatchers API reference.

    article

    TlsMatchers

    TlsMatchers API reference.

    article

    TransformationPolicy

    TransformationPolicy API reference.

    article

    TrimProxyConfigPolicy

    TrimProxyConfigPolicy API reference.

    article

    VaultCa

    VaultCa API reference.

    article

    VirtualDestination

    VirtualDestination API reference.

    article

    VirtualGateway

    VirtualGateway API reference.

    article

    WafPolicy

    WafPolicy API reference.

    article

    Workspace

    Workspace API reference.

    article

    WorkspaceSettings

    WorkspaceSettings API reference.

    Solo.io copyright 2025