APIs.io Engineering Platform Amazon API Gateway — Restapis

naftiko: 1.0.0-alpha2
info:
  label: APIs.io Engineering Platform Amazon API Gateway — Restapis
  description: 'APIs.io Engineering Platform Amazon API Gateway — Restapis. 75 operations. Lead operation: Restapis. Self-contained
    Naftiko capability covering one Engineering Platform business surface.'
  tags:
  - Engineering Platform
  - Restapis
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ENGINEERING_PLATFORM_API_KEY: ENGINEERING_PLATFORM_API_KEY
capability:
  consumes:
  - type: http
    namespace: aws-api-gateway-restapis
    baseUri: http://apigateway.{region}.amazonaws.com
    description: APIs.io Engineering Platform Amazon API Gateway — Restapis business capability. Self-contained, no shared
      references.
    resources:
    - name: restapis
      path: /restapis
      operations:
      - name: createrestapi
        method: POST
        description: Creates a new RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getrestapis
        method: GET
        description: Lists the RestApis resources for your collection.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id
      path: /restapis/{restapi_id}
      operations:
      - name: deleterestapi
        method: DELETE
        description: Deletes the specified API.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
      - name: getrestapi
        method: GET
        description: Lists the RestApi resource in the collection.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
      - name: putrestapi
        method: PUT
        description: A feature of the API Gateway control service for updating an existing API with an input of external API
          definitions. The update can take the form of merging the supplied definition into the existing API or overwriting
          the existing API.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: mode
          in: query
          type: string
          description: The <code>mode</code> query parameter to specify the update mode. Valid values are "merge" and "overwrite".
            By default, the update mode is "merge".
        - name: failonwarnings
          in: query
          type: boolean
          description: A query parameter to indicate whether to rollback the API update (<code>true</code>) or not (<code>false</code>)
            when a warning is encountered. The default valu
        - name: parameters
          in: query
          type: object
          description: Custom header parameters as part of the request. For example, to exclude DocumentationParts from an
            imported API, set <code>ignore=documentation</code> as a <co
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updaterestapi
        method: PATCH
        description: Changes information about the specified API.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-authorizers
      path: /restapis/{restapi_id}/authorizers
      operations:
      - name: createauthorizer
        method: POST
        description: Adds a new Authorizer resource to an existing RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getauthorizers
        method: GET
        description: Describe an existing Authorizers resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id-authorizers-authorizer_id
      path: /restapis/{restapi_id}/authorizers/{authorizer_id}
      operations:
      - name: deleteauthorizer
        method: DELETE
        description: Deletes an existing Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: authorizer_id
          in: path
          type: string
          description: The identifier of the Authorizer resource.
          required: true
      - name: getauthorizer
        method: GET
        description: Describe an existing Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: authorizer_id
          in: path
          type: string
          description: The identifier of the Authorizer resource.
          required: true
      - name: testinvokeauthorizer
        method: POST
        description: Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request
          body.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: authorizer_id
          in: path
          type: string
          description: Specifies a test invoke authorizer request's Authorizer ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateauthorizer
        method: PATCH
        description: Updates an existing Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: authorizer_id
          in: path
          type: string
          description: The identifier of the Authorizer resource.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-deployments
      path: /restapis/{restapi_id}/deployments
      operations:
      - name: createdeployment
        method: POST
        description: Creates a Deployment resource, which makes a specified RestApi callable over the internet.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getdeployments
        method: GET
        description: Gets information about a Deployments collection.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id-deployments-deployment_id
      path: /restapis/{restapi_id}/deployments/{deployment_id}
      operations:
      - name: deletedeployment
        method: DELETE
        description: Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources
          associated with it.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: deployment_id
          in: path
          type: string
          description: The identifier of the Deployment resource to delete.
          required: true
      - name: getdeployment
        method: GET
        description: Gets information about a Deployment resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: deployment_id
          in: path
          type: string
          description: The identifier of the Deployment resource to get information about.
          required: true
        - name: embed
          in: query
          type: array
          description: 'A query parameter to retrieve the specified embedded resources of the returned Deployment resource
            in the response. In a REST API call, this <code>embed</code> '
      - name: updatedeployment
        method: PATCH
        description: Changes information about a Deployment resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: deployment_id
          in: path
          type: string
          description: The replacement identifier for the Deployment resource to change information about.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-documentation-parts
      path: /restapis/{restapi_id}/documentation/parts
      operations:
      - name: createdocumentationpart
        method: POST
        description: Creates a documentation part.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getdocumentationparts
        method: GET
        description: Gets documentation parts.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: type
          in: query
          type: string
          description: The type of API entities of the to-be-retrieved documentation parts.
        - name: name
          in: query
          type: string
          description: The name of API entities of the to-be-retrieved documentation parts.
        - name: path
          in: query
          type: string
          description: The path of API entities of the to-be-retrieved documentation parts.
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
        - name: locationStatus
          in: query
          type: string
          description: The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for
            retrieving DocumentationPart resources with content and <cod
      - name: importdocumentationparts
        method: PUT
        description: Imports documentation parts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: mode
          in: query
          type: string
          description: 'A query parameter to indicate whether to overwrite (<code>OVERWRITE</code>) any existing DocumentationParts
            definition or to merge (<code>MERGE</code>) the new '
        - name: failonwarnings
          in: query
          type: boolean
          description: A query parameter to specify whether to rollback the documentation importation (<code>true</code>)
            or not (<code>false</code>) when a warning is encountered. Th
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-documentation-parts-part_id
      path: /restapis/{restapi_id}/documentation/parts/{part_id}
      operations:
      - name: deletedocumentationpart
        method: DELETE
        description: Deletes a documentation part
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: part_id
          in: path
          type: string
          description: The identifier of the to-be-deleted documentation part.
          required: true
      - name: getdocumentationpart
        method: GET
        description: Gets a documentation part.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: part_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
      - name: updatedocumentationpart
        method: PATCH
        description: Updates a documentation part.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: part_id
          in: path
          type: string
          description: The identifier of the to-be-updated documentation part.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-documentation-versions
      path: /restapis/{restapi_id}/documentation/versions
      operations:
      - name: createdocumentationversion
        method: POST
        description: Creates a documentation version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getdocumentationversions
        method: GET
        description: Gets documentation versions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id-documentation-versions-doc_version
      path: /restapis/{restapi_id}/documentation/versions/{doc_version}
      operations:
      - name: deletedocumentationversion
        method: DELETE
        description: Deletes a documentation version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: doc_version
          in: path
          type: string
          description: The version identifier of a to-be-deleted documentation snapshot.
          required: true
      - name: getdocumentationversion
        method: GET
        description: Gets a documentation version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: doc_version
          in: path
          type: string
          description: The version identifier of the to-be-retrieved documentation snapshot.
          required: true
      - name: updatedocumentationversion
        method: PATCH
        description: Updates a documentation version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi..
          required: true
        - name: doc_version
          in: path
          type: string
          description: The version identifier of the to-be-updated documentation version.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-gatewayresponses
      path: /restapis/{restapi_id}/gatewayresponses
      operations:
      - name: getgatewayresponses
        method: GET
        description: 'Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions
          for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the
          supported response '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set. The GatewayResponse collection does not support
            pagination and the position does not apply here.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
            The GatewayResponses collection does not support paginati
    - name: restapis-restapi_id-gatewayresponses-response_type
      path: /restapis/{restapi_id}/gatewayresponses/{response_type}
      operations:
      - name: deletegatewayresponse
        method: DELETE
        description: Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets
          it with the default settings.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: response_type
          in: path
          type: string
          description: The response type of the associated GatewayResponse.
          required: true
      - name: getgatewayresponse
        method: GET
        description: Gets a GatewayResponse of a specified response type on the given RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: response_type
          in: path
          type: string
          description: The response type of the associated GatewayResponse.
          required: true
      - name: putgatewayresponse
        method: PUT
        description: Creates a customization of a GatewayResponse of a specified response type and status code on the given
          RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: response_type
          in: path
          type: string
          description: The response type of the associated GatewayResponse
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updategatewayresponse
        method: PATCH
        description: Updates a GatewayResponse of a specified response type on the given RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: response_type
          in: path
          type: string
          description: The response type of the associated GatewayResponse.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-models
      path: /restapis/{restapi_id}/models
      operations:
      - name: createmodel
        method: POST
        description: Adds a new Model resource to an existing RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The RestApi identifier under which the Model will be created.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getmodels
        method: GET
        description: Describes existing Models defined for a RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id-models-model_name
      path: /restapis/{restapi_id}/models/{model_name}
      operations:
      - name: deletemodel
        method: DELETE
        description: Deletes a model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: model_name
          in: path
          type: string
          description: The name of the model to delete.
          required: true
      - name: getmodel
        method: GET
        description: Describes an existing model defined for a RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The RestApi identifier under which the Model exists.
          required: true
        - name: model_name
          in: path
          type: string
          description: The name of the model as an identifier.
          required: true
        - name: flatten
          in: query
          type: boolean
          description: A query parameter of a Boolean value to resolve (<code>true</code>) all external model references and
            returns a flattened model schema or not (<code>false</code
      - name: updatemodel
        method: PATCH
        description: Changes information about a model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: model_name
          in: path
          type: string
          description: The name of the model to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: restapis-restapi_id-models-model_name-default_template
      path: /restapis/{restapi_id}/models/{model_name}/default_template
      operations:
      - name: getmodeltemplate
        method: GET
        description: Generates a sample mapping template that can be used to transform a payload into the structure of a model.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: model_name
          in: path
          type: string
          description: The name of the model for which to generate a template.
          required: true
    - name: restapis-restapi_id-requestvalidators
      path: /restapis/{restapi_id}/requestvalidators
      operations:
      - name: createrequestvalidator
        method: POST
        description: Creates a RequestValidator of a given RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getrequestvalidators
        method: GET
        description: Gets the RequestValidators collection of a given RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          description: The string identifier of the associated RestApi.
          required: true
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: limit
          in: query
          type: integer
          description: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - name: restapis-restapi_id-requestvalidators-requestvalidator_id
      path: /restapis/{restapi_id}/requestvalidators/{requestvalidator_id}
      operations:
      - name: deleterequestvalidator
        method: DELETE
        description: Deletes a RequestValidator of a given RestApi.
        outputRawFormat: json
        outputParameters:
     

# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/capabilities/aws-api-gateway-restapis.yaml