Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Creates a new BasePathMapping resource.

post/domainnames/{domain_name}/basepathmappings

Path parameters

domain_namestring required

The domain name of the BasePathMapping resource to create.

Request body

basePathstring

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

restApiIdstring required

The string identifier of the associated RestApi.

stagestring

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

Response

Success

basePathstring

The base path name that callers of the API must provide as part of the URL after the domain name.

restApiIdstring

The string identifier of the associated RestApi.

stagestring

The name of the associated stage.