Amazon API Gateway REST API Reference

BasePathMapping

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


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
basepathmapping:create

Creates a new base path mapping.

POST No
basepathmapping:update

Changes information about the base path mapping resource.

PATCH No
basepathmapping:delete

Deletes the base path mapping resource.

DELETE No


Properties

{
  "basePath" : "String",
  "restApiId" : "String",
  "stage" : "String"
}

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

  • restApiId
  • The string identifier of the associated RestApi.

  • stage
  • The name of the associated stage.

Remarks

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.

See Also

Use Custom Domain Names