POST

/restapis

http://apigateway.{region}.amazonaws.com/restapis

Creates a new RestApi resource.

Access Token Required: API Key

Body Params

namestringrequired

The name of the RestApi.

tagsobject

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.

policystring

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

versionstring

A version identifier for the API.

cloneFromstring

The ID of the RestApi that you want to clone from.

descriptionstring

The description of the RestApi.

apiKeySourcestring

The source of the API key for metering requests according to a usage plan. Valid values are: ><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. <code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.

binaryMediaTypesarray

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

endpointConfigurationobject

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

minimumCompressionSizeinteger

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

disableExecuteApiEndpointboolean

Specifies whether clients can invoke your API by using the default <code>execute-api</code> endpoint. By default, clients can invoke your API with the default <code>https://{api_id}.execute-api.{region}.amazonaws.com</code> endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://apigateway.{region}.amazonaws.com/restapis' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}