View a markdown version of this page

Document revisions - Best Practices for Designing Amazon API Gateway Private APIs and Private Integration

Document revisions

To be notified about updates to this whitepaper, subscribe to the RSS feed.

ChangeDescriptionDate

Whitepaper updated

Updated for private custom domain names (November 2024), VPC links V2 with ALB for REST APIs (November 2025), IPv6 dualstack for private APIs (March 2025), DNS failover with CloudWatch health checks (October 2022), routing rules for custom domains (June 2025), and enhanced TLS security policies (November 2025). Added new patterns: Cross-Account Private Custom Domain Name, Multi-Region Private Custom Domain Names. Updated patterns to recommend VPC links V2 with ALB. Added best practices, VPC link V2 operational considerations, and cost comparison sections.

July 14, 2026

Whitepaper updated

Added new sections on custom domain names for private APIs

April 3, 2025

Whitepaper updated

Added new sections on private integrations cross-account, and multi-Region API Gateway

August 26, 2022

Initial publication

Whitepaper published.

January 3, 2021