Amazon API Gateway · Schema

RestApi

AWSGatewayHTTP APIREST APIServerlessWebSocket

Properties

Name Type Description
id string The API's identifier.
name string The API's name.
description string The API's description.
createdDate string The timestamp when the API was created.
version string A version identifier for the API.
warnings array The warning messages reported when failonwarnings is on.
binaryMediaTypes array The list of binary media types supported by the REST API.
minimumCompressionSize integer A nullable integer for the minimum payload size in bytes to compress.
apiKeySource string The source of the API key for metering requests.
endpointConfiguration object
policy string A stringified JSON policy document that applies to this REST API.
tags object Tags attached to the REST API.
disableExecuteApiEndpoint boolean Specifies whether clients can invoke your API by using the default execute-api endpoint.
View JSON Schema on GitHub