Amazon API Gateway
API Reference

Api

Represents an API.

URI

/v2/apis/apiId

HTTP Methods

GET

Operation ID: GetApi

Gets an Api resource.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

Responses

Status Code Response Model Description
200 Api

Success

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeleteApi

Deletes an Api resource.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

Responses

Status Code Response Model Description
204 None

The request has succeeded, and there is no additional content to send in the response payload body.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdateApi

Updates an Api resource.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

Responses

Status Code Response Model Description
200 Api

Success

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request Bodies

Example PATCH

{ "name": "string", "description": "string", "version": "string", "routeSelectionExpression": "string", "apiKeySelectionExpression": "string", "disableSchemaValidation": boolean }

Response Bodies

Example Api

{ "apiId": "string", "name": "string", "description": "string", "version": "string", "protocolType": enum, "routeSelectionExpression": "string", "apiKeySelectionExpression": "string", "disableSchemaValidation": boolean, "warnings": [ "string" ], "apiEndpoint": "string", "createdDate": "string", "tags": { } }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

Api

Represents an API.

Property Type Required Description
apiId

string

False

The API ID.

name

string

True

The name of the API.

description

string

False

The description of the API.

version

string

False

A version identifier for the API.

protocolType

ProtocolType

True

The API protocol: Currently only WEBSOCKET is supported.

routeSelectionExpression

string

True

The route selection expression for the API.

apiKeySelectionExpression

string

False

An API key selection expression. See API Key Selection Expressions.

disableSchemaValidation

boolean

False

Avoid validating models when creating a deployment.

warnings

Array of type string

False

The warning messages reported when failonwarnings is turned on during API import.

apiEndpoint

string

Format: uri

False

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

createdDate

string

Format: date-time

False

The timestamp when the API was created.

tags

Tags

False

A collection of tags associated with the API.

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

ProtocolType

Represents a protocol type.

  • WEBSOCKET

Tags

Represents a collection of tags associated with the resource.

Property Type Required Description

*

string

False

UpdateApiInput

Represents the input parameters for an UpdateApi request.

Property Type Required Description
name

string

False

The name of the API.

description

string

False

The description of the API.

version

string

False

A version identifier for the API.

routeSelectionExpression

string

False

The route selection expression for the API.

apiKeySelectionExpression

string

False

An API key selection expression. See API Key Selection Expressions.

disableSchemaValidation

boolean

False

Avoid validating models when creating a deployment.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetApi

DeleteApi

UpdateApi