Amazon API Gateway REST API Reference

RestApis

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.


Relation Description Method Templated
self

A relation that refers to the current resource.

GET No
restapi:by-id

Gets the RestApi resource with the specified identifier.

This link relation offers the following templated variable(s):

  • restapi_id: Required.

    The identifier of the RestApi resource.

GET Yes
restapi:create

Creates a new API represented by a RestApi instance in API Gateway.

POST No
restapi:put

Update the definition of a REST API, including the resources, methods, templates, and models.

This link relation offers the following templated variable(s):

  • restapi_id: Required.

    The identifier of the RestApi to be updated.

  • mode: Optional.

    The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

  • failonwarnings: Optional.

    A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

PUT Yes
next

The next page of items in the collection. This link is not returned for the last page.

GET No
first

The first page of items in a collection. This link is not returned for the first page.

GET No
item

An array of links to the current page of RestApi resources.

GET No


Properties

The RestApis resource does not have any properties.

Remarks

See Also

Create an API