GetBasePathMappings - Amazon API Gateway


Represents a collection of BasePathMapping resources.

Request Syntax

GET /domainnames/domain_name/basepathmappings?limit=limit&position=position HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The domain name of a BasePathMapping resource.

Required: Yes


The maximum number of returned results per page. The default value is 25 and the maximum value is 500.


The current pagination position in the paged result set.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "item": [ { "basePath": "string", "restApiId": "string", "stage": "string" } ], "position": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The current page of elements from this collection.

Type: Array of BasePathMapping objects


The current pagination position in the paged result set.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Get the base path mappings of a custom domain name

This example illustrates one usage of GetBasePathMappings.

Sample Request

GET /domainnames/ HTTP/1.1 Content-Type: application/json Host: X-Amz-Date: 20160615T221921Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160615/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Sample Response

{ "_links": { "curies": { "href": "{rel}.html", "name": "basepathmapping", "templated": true }, "self": { "href": "/domainnames/{?limit}", "templated": true }, "basepathmapping:by-path": { "href": "/domainnames/{base_path}", "templated": true }, "basepathmapping:create": { "href": "/domainnames/" }, "item": [ { "href": "/domainnames/" }, { "href": "/domainnames/" } ] }, "_embedded": { "item": [ { "_links": { "self": { "href": "/domainnames/" }, "basepathmapping:create": { "href": "/domainnames/" }, "basepathmapping:delete": { "href": "/domainnames/" }, "basepathmapping:update": { "href": "/domainnames/" } }, "basepath": "my-service-api", "restApiId": "fugvjdxtri", "stage": "stage2" }, { "_links": { "self": { "href": "/domainnames/" }, "basepathmapping:create": { "href": "/domainnames/" }, "basepathmapping:delete": { "href": "/domainnames/" }, "basepathmapping:update": { "href": "/domainnames/" } }, "basepath": "my-sample-api", "restApiId": "fugvjdxtri", "stage": "stage1" } ] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: