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

APIs.io Engineering Platform 2021 10 31 API

The 2021 10 31 API from APIs.io Engineering Platform — 2 operation(s) for 2021 10 31.

This API exposes 5 operations across 2 paths, and defines 26 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.

5 operations 2 paths 26 schemas 1 DELETE2 GET1 POST1 PUT

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
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform 2021 10 31 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 5

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

2021 10 31 5
POST
/2021-10-31/functions/{FunctionName}/url
Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.
CreateFunctionUrlConfig 9 params body → 201480481482483484
DELETE
/2021-10-31/functions/{FunctionName}/url
Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address.
DeleteFunctionUrlConfig 9 params → 204480481482483
GET
/2021-10-31/functions/{FunctionName}/url
Returns details about a Lambda function URL.
GetFunctionUrlConfig 9 params → 200480481482483
PUT
/2021-10-31/functions/{FunctionName}/url
Updates the configuration for a Lambda function URL.
UpdateFunctionUrlConfig 9 params body → 200480481482483484
GET
/2021-10-31/functions/{FunctionName}/urls
Returns a list of Lambda function URLs for the specified function.
ListFunctionUrlConfigs 10 params → 200480481482483

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are GetFunctionUrlConfigResponse (7 properties), UpdateFunctionUrlConfigResponse (7 properties), FunctionUrlConfig (7 properties), Cors (6 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
HeadersList
array
FunctionArn
string
AllowCredentials
boolean
Timestamp
string
FunctionUrlConfig
object
Details about a Lambda function URL.
7 properties 5 required
ResourceConflictException
InvalidParameterValueException
Header
string
AllowOriginsList
array
FunctionUrl
string
MaxAge
integer
ListFunctionUrlConfigsResponse
object
2 properties 1 required
AllowMethodsList
array
Origin
string
String
string
UpdateFunctionUrlConfigResponse
object
7 properties 5 required
FunctionUrlAuthType
string
Cors
object
The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use…
6 properties
InvokeMode
string
ServiceException
Method
string
ResourceNotFoundException
GetFunctionUrlConfigResponse
object
7 properties 5 required
FunctionUrlConfigList
array
CreateFunctionUrlConfigResponse
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-2021-10-31-api-openapi.yml Raw ↑