APIs.io Engineering Platform Domainnames API

The Domainnames API from APIs.io Engineering Platform — 4 operation(s) for domainnames.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 10 operations across 4 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

10 operations 4 paths 24 schemas 2 DELETE4 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Domainnames API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Domainnames 10

POST

/domainnames/{domain_name}/basepathmappings

Creates a new BasePathMapping resource.

CreateBasePathMapping 8 params body → 201480481482483484485

GET

/domainnames/{domain_name}/basepathmappings

Represents a collection of BasePathMapping resources.

GetBasePathMappings 10 params → 200480481482483

POST

/domainnames

Creates a new domain name.

CreateDomainName 7 params body → 201480481482483484

GET

/domainnames

Represents a collection of DomainName resources.

GetDomainNames 9 params → 200480481482483

DELETE

/domainnames/{domain_name}/basepathmappings/{base_path}

Deletes the BasePathMapping resource.

DeleteBasePathMapping 9 params → 202480481482483484

GET

/domainnames/{domain_name}/basepathmappings/{base_path}

Describe a BasePathMapping resource.

GetBasePathMapping 9 params → 200480481482483

PATCH

/domainnames/{domain_name}/basepathmappings/{base_path}

Changes information about the BasePathMapping resource.

UpdateBasePathMapping 9 params body → 200480481482483484485

DELETE

/domainnames/{domain_name}

Deletes the DomainName resource.

DeleteDomainName 8 params → 202480481482483484

GET

/domainnames/{domain_name}

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

GetDomainName 8 params → 200480481482483

PATCH

/domainnames/{domain_name}

Changes information about the DomainName resource.

UpdateDomainName 8 params body → 200480481482483484485

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are DomainName (17 properties), PatchOperation (4 properties), BasePathMapping (3 properties), MutualTlsAuthentication (3 properties). Each schema is shown below with its type and property counts.

DomainNames

object

Represents a collection of DomainName resources.

2 properties

TooManyRequestsException

NotFoundException

DomainName

object

Represents a custom domain name as a user-friendly host name of an API (RestApi).

17 properties

string

ListOfBasePathMapping

array

UnauthorizedException

ConflictException

Timestamp

string

BadRequestException

PatchOperation

object

For more information about supported patch operations, see Patch Operations .

4 properties

LimitExceededException

ListOfEndpointType

array

EndpointType

string

The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, mos…

String

string

DomainNameStatus

string

ListOfString

array

ListOfDomainName

array

BasePathMappings

object

Represents a collection of BasePathMapping resources.

2 properties

MapOfStringToString

object

EndpointConfiguration

object

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

2 properties

SecurityPolicy

string

BasePathMapping

object

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

3 properties

MutualTlsAuthentication

object

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the serv…

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Domainnames

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Domainnames API

Metadata

Authentication & Security 1

Paths & Operations 10

Schemas 24

Specification

Source

API Details

Provider

Explore more