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

AWS App Runner Custom Domains API

Manage custom domain associations

AWS App Runner Custom Domains API is one of 13 APIs that AWS App Runner publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2020-05-15.

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

3 operations 3 paths 2 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2020-05-15
Base URL
https://apprunner.{region}.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS App Runner Custom Domains API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_sig_v4). By default, every request must be authenticated.

  • aws_sig_v4 — AWS Signature Version 4

Paths & Operations 3

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

Custom Domains 3

Manage custom domain associations

POST
/#AssociateCustomDomain
AWS App Runner Associate a Custom Domain
AssociateCustomDomain 1 param body → 200
POST
/#DescribeCustomDomains
AWS App Runner Describe Custom Domains
DescribeCustomDomains 1 param body → 200
POST
/#DisassociateCustomDomain
AWS App Runner Disassociate a Custom Domain
DisassociateCustomDomain 1 param body → 200

Schemas 2

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

VpcDNSTarget
object
3 properties
CustomDomain
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-app-runner-custom-domains-api-openapi.yml Raw ↑

Other APIs AWS App Runner publishes across the network.

AWS App Runner Auto Scaling API
AWS App Runner AWS App Runner API API
AWS App Runner Connections API
AWS App Runner #DeleteService API
AWS App Runner Deployments API
AWS App Runner #DescribeService API
AWS App Runner #ListServices API
AWS App Runner Observability API
AWS App Runner #PauseService API
AWS App Runner #ResumeService API
AWS App Runner #UpdateService API
AWS App Runner VPC API