Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon API Gateway Base Path Mappings API

Operations for managing base path mappings

Amazon API Gateway Base Path Mappings API is one of 18 APIs that Amazon API Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Base Path Mappings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, a getting-started guide, an API reference, a JSON-LD context, and 8 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2015-07-09.

Requests are made against a single base URL, https://apigateway.{region}.amazonaws.com.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2015-07-09
Base URL
https://apigateway.{region}.amazonaws.com
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Amazon API Gateway Base Path Mappings API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (sigv4). By default, every request must be authenticated.

  • sigv4 — AWS Signature Version 4 authentication

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Base Path Mappings 2

Operations for managing base path mappings

GET
/domainnames/{domain_name}/basepathmappings
Amazon API Gateway List Base Path Mappings
GetBasePathMappings 3 params → 200404429
POST
/domainnames/{domain_name}/basepathmappings
Amazon API Gateway Create a Base Path Mapping
CreateBasePathMapping 1 param body → 201400404409429

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are BasePathMapping (3 properties), CreateBasePathMappingRequest (3 properties), BasePathMappings (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
BasePathMappings
object
2 properties
CreateBasePathMappingRequest
object
3 properties 1 required
BasePathMapping
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-api-gateway-base-path-mappings-api-openapi.yml Raw ↑

Other APIs Amazon API Gateway publishes across the network.

Amazon API Gateway WebSocket API
Amazon API Gateway HTTP API
Amazon API Gateway Management API
Amazon API Gateway API Keys API
Amazon API Gateway Authorizers API
Amazon API Gateway Deployments API
Amazon API Gateway Documentation API
Amazon API Gateway Domain Names API
Amazon API Gateway Gateway Responses API
Amazon API Gateway Methods API
Amazon API Gateway Models API
Amazon API Gateway Request Validators API