All Products
Search
Document Center

API Gateway:HttpApiVersionConfig

Last Updated:Mar 26, 2026
ParameterTypeDescriptionExample
object

The versioning configurations.

enableboolean

Specifies whether to enable versioning.

true
schemestring

The versioning solution.

Valid values:

  • Path
  • Query
  • Header
Query
headerNamestring

The key in the specified header when the header versioning solution is used.

my-version
queryNamestring

The key in the specified query parameter when the query versioning solution is used.

myVersion
versionstring

The version number.

v1