SUMMARY.md

Table of contents

Overview

• Introduction to Gravitee API Management (APIM)
• APIM Architecture
  • Production Deployments and Capacity Planning
• Plugins
• Integrations
• Gravitee APIM Enterprise Edition
  • Enterprise Edition Licensing
• Gravitee API Definitions and Execution Engines
  • Reactive Execution Engine
  • Engine Comparisons

Getting Started

• Installing Gravitee API Management
  • Installing a self-hosted Gravitee API Management platform
    • Installing Gravitee API Management on an Amazon instance
      • Installing Gravitee API Management on an Amazon instance with Quick install
      • Installing Gravitee APIM on an Amazon instance with Manual Install
    • Installing Gravitee API Mangement with Docker
      • Quick Install Gravitee API Management with Docker Compose
      • Custom Install Gravitee API Management with Docker Compose
      • Install Gravitee API Management with Docker Images Install
      • Customizing your Gravitee API Management installation on Docker
    • Installing Gravitee API Management on Kubernetes
    • Installing Gravitee API Management using RPM Packages
    • Installing Gravitee API Management with .ZIP
  • Installing a Gravitee Gateway with a Hybrid Deployment
    • Installing a Gravitee Gateway with a Hybrid Deployment on Kubernetes
    • Installing a Gravitee Gateway with a Hybrid Deployment
    • Components of Hybrid architecture
    • Gateway and Bridge compatibility versions
  • Multi-tenancy
• Upgrading Gravitee API Management
  • Upgrade Guide
  • Upgrading Gravitee API Management installed with RPM packages
  • Breaking changes and deprecated functionality for API Management
• Quickstart Guide
  • Gateway APIs 101 - Traditional & Message Proxies
    • Traditional Proxy
    • Message Proxy
  • Plans and Policies 101
  • Developer Portal 101
  • What's Next
• Configuration
  • APIM Gateway
    • General Configuration
    • Internal API
    • OpenTracing
    • Logging
    • Sharding tags
    • Tenants
    • Dictionaries
    • Shared policy groups
      • Shared policy groups overview
      • Creating shared policy groups
      • Adding a policy chain
      • Adding a shared policy group
      • Editing a shared group policy
      • Viewing version history of the shared policy group
      • Default AI flows overview
      • Limitations
  • APIM Management API
    • General Configuration
    • User and Management Configuration
    • Internal API
    • Security
  • APIM Console
  • APIM Developer Portal
  • Repositories
    • Elasticsearch
    • MongoDB
    • JDBC
    • Redis
  • Reporters
    • Formats
  • Cache
  • HTTP Reverse Proxy
  • Authentication
    • Authentication Providers
    • Gravitee AM Authentication
    • Social Providers
    • Custom OAuth2/OpenID Authorization Server
    • Azure AD / Entra ID
  • Notifications
  • Production-ready APIM Environment
    • Internal APIs
    • Deployment
    • Authentication
    • Brute-force an Browser Protection
    • Configuration Settings
    • APIM Safe Practices
  • Secret Providers

Most common use cases

• Rate Limiting REST API Use Cases
• Configure JWT Security with APIM
• Adding Role-based Access Control to your JWT Plan
• Configure Dynamic Client Registration with APIM
• Secure and Expose gRPC Services with Gravitee
• Exposing SOAP webservices as REST APIs

Guides

• Create APIs
  • Import APIs
    • OpenAPI Spec Import
  • The API Creation Wizard
    • v4 API creation wizard
    • v2 API creation wizard
• API Configuration
  • v4 API Configuration
    • Entrypoints
      • v4 Proxy API Entrypoints
      • v4 Message API Entrypoints
        • HTTP GET
        • HTTP POST
        • WebSocket
        • Webhook
        • Server-sent Events
      • Response Templates
      • CORS
    • Endpoints
      • v4 Proxy API Endpoints
      • v4 Message API Endpoints
        • Kafka
        • MQTT5
        • Solace
        • RabbitMQ
        • Mock
      • Health-check
    • Quality of Service
    • General Info Settings
    • User Permissions
    • Audit Logs
    • Version History
    • Documentation
  • v2 API Configuration
    • General Info Settings
    • Proxy Settings
    • Documentation
    • Load-balancing, Failover, and Health-checks
    • Service Discovery
    • User and Group Access
  • Resources
• Policy Studio
  • v2 API Policy Studio
  • v4 API Policy Studio
• API Exposure: Plans, Applications, & Subscriptions
  • Plans
    • Keyless
    • API Key
    • JWT
    • OAuth2
    • mTLS
      • mTLS plans overview
      • Adding a Client Certificate to an Application
      • Calling an API with mTLS
      • Terminating TLS in front of the Gateway
    • Push
  • Applications
  • Subscriptions
• Developer Portal
  • Configuration
    • General Settings
    • User Management
    • Layout and Theme Customization
    • Documentation
  • Tools and Features
    • Webhook Subscription Management
    • Applications
    • Documentation
• API Measurement, Tracking, and Analytics
  • Dashboards
  • API Quality
  • Audit Trail
• Gravitee Expression Language
• Federation
  • Integrations
  • Discovery
  • Federated APIs
  • Create a service account for the federation agent
  • 3rd-party providers
    • AWS API Gateway
    • Solace
    • IBM API Connect
    • Azure API Management
    • Confluent Platform
    • Apigee X
• Administration
  • Administering organizations and environments
  • User Management and Permissions
  • Support
• Developer Contributions
  • Custom Plugins
  • Custom Policies

Reference

• Management API Reference
• Policy Reference
  • API Key
  • Assign Attributes
  • Assign Content
  • Assign Metrics
  • AVRO to JSON
  • AVRO to Protobuf
  • AWS Lambda
  • Basic Authentication
  • Cache
  • Circuit Breaker
  • Cloud Events
  • Data Logging Masking
  • Dynamic Routing
  • Generate HTTP Signature
  • Generate JWT
  • GeoIP Filtering
  • GraphQL Rate Limit
  • Groovy
  • HTTP Callout
  • HTTP Signature
  • Interrupt
  • IP filtering
  • Javascript
  • JSON to JSON
  • JSON to XML
  • JSON Threat Protection
  • JSON Validation
  • JSON Web Signature (JWS)
  • JSON Web Token (JWT)
  • Keyless
  • Latency
  • Message Filtering
  • Mock
  • OAS Validation
  • OAuth2
    • Generic OAuth2 Authorization Server
    • Gravitee.io AM Authorization Server
  • OpenID Connect UserInfo
  • Override HTTP Method
  • Protobuf to JSON
  • Rate Limit
  • Regex Threat Protection
  • Request Content Limit
  • Request Validation
  • Resource Filtering
  • REST to SOAP
  • Retry
  • Role-based Access Control (RBAC)
  • SSL Enforcement
  • Traffic Shadowing
  • Transform Headers
  • Transform Query Parameters
  • WS Security Authentication
  • XML to JSON
  • XML Threat Protection
  • XML Validation
  • XSLT
• Endpoint Reference
  • Kafka
  • MQTT5
  • Solace
  • RabbitMQ
  • Azure Service Bus
• Entrypoint Reference
  • Server-sent Events
  • Webhook
• Azure regions for SaaS and Hybrid Deployments

Releases & Changelog

• Release Notes
  • APIM 4.5
  • APIM 4.4
  • APIM 4.3
  • APIM 4.2
  • APIM 4.1
  • APIM 4.0
• Changelog
  • APIM 4.4.x
  • APIM 4.3.x
  • APIM 4.2.x
  • APIM 4.1.x
  • APIM 4.0.x

Community & Support

• Enterprise Support
• Community
  • Support
  • Announcements & Events