All Products
Search
Document Center

API Gateway:HttpApiVersionConfig

Last Updated:Dec 17, 2025
ParameterTypeDescriptionExample
object

API Versioning Configuration.

enableboolean

Indicates whether versioning control is enabled.

true
schemestring

The versioning scheme.

Enumeration Value:
  • Path: Path.
  • Query: Query.
  • Header: Header.
Query
headerNamestring

The key in the Header parameter when using the Header versioning scheme.

my-version
queryNamestring

The key in the Query parameter when using the Query versioning scheme.

myVersion
versionstring

The version number.

v1