APIs.io Engineering Platform Amazon API Gateway

naftiko: 1.0.0-alpha2
info:
  label: APIs.io Engineering Platform Amazon API Gateway
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and
    scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications
    to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  tags:
  - Engineering
  - Platform
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: engineering-platform
    baseUri: http://apigateway.us-east-1.amazonaws.com
    description: APIs.io Engineering Platform Amazon API Gateway HTTP API.
    authentication:
      type: apikey
      in: header
      name: Authorization
      value: '{{ENGINEERING_PLATFORM_TOKEN}}'
    resources:
    - name: apikeys
      path: /apikeys
      operations:
      - name: createapikey
        method: POST
        description: Create an ApiKey resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getapikeys
        method: GET
        description: Gets information about the current ApiKeys resource.
        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: name
          in: query
          type: string
          description: The name of queried API keys.
        - name: customerId
          in: query
          type: string
          description: The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
        - name: includeValues
          in: query
          type: boolean
          description: A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains
            key values.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getauthorizers
        method: GET
        description: Describe an existing Authorizers resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: domainnames-domain-name-basepathmappings
      path: /domainnames/{domain_name}/basepathmappings
      operations:
      - name: createbasepathmapping
        method: POST
        description: Creates a new BasePathMapping resource.
        inputParameters:
        - name: domain_name
          in: path
          type: string
          required: true
          description: The domain name of the BasePathMapping resource to create.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getbasepathmappings
        method: GET
        description: Represents a collection of BasePathMapping resources.
        inputParameters:
        - name: domain_name
          in: path
          type: string
          required: true
          description: The domain name of a BasePathMapping resource.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdeployments
        method: GET
        description: Gets information about a Deployments collection.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis-restapi-id-documentation-parts
      path: /restapis/{restapi_id}/documentation/parts
      operations:
      - name: createdocumentationpart
        method: POST
        description: Creates a documentation part.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdocumentationparts
        method: GET
        description: Gets documentation parts.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: importdocumentationparts
        method: PUT
        description: Imports documentation parts
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis-restapi-id-documentation-versions
      path: /restapis/{restapi_id}/documentation/versions
      operations:
      - name: createdocumentationversion
        method: POST
        description: Creates a documentation version
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdocumentationversions
        method: GET
        description: Gets documentation versions.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: domainnames
      path: /domainnames
      operations:
      - name: createdomainname
        method: POST
        description: Creates a new domain name.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdomainnames
        method: GET
        description: Represents a collection of DomainName resources.
        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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The RestApi identifier under which the Model will be created.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getmodels
        method: GET
        description: Describes existing Models defined for a RestApi resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis-restapi-id-requestvalidators
      path: /restapis/{restapi_id}/requestvalidators
      operations:
      - name: createrequestvalidator
        method: POST
        description: Creates a RequestValidator of a given RestApi.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getrequestvalidators
        method: GET
        description: Gets the RequestValidators collection of a given RestApi.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis-restapi-id-resources-parent-id
      path: /restapis/{restapi_id}/resources/{parent_id}
      operations:
      - name: createresource
        method: POST
        description: Creates a Resource resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: parent_id
          in: path
          type: string
          required: true
          description: The parent resource's identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis
      path: /restapis
      operations:
      - name: createrestapi
        method: POST
        description: Creates a new RestApi resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getrestapis
        method: GET
        description: Lists the RestApis resources for your collection.
        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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: restapis-restapi-id-stages
      path: /restapis/{restapi_id}/stages
      operations:
      - name: createstage
        method: POST
        description: Creates a new Stage resource that references a pre-existing Deployment for the API.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getstages
        method: GET
        description: Gets information about one or more Stage resources.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: deploymentId
          in: query
          type: string
          description: The stages' deployment identifiers.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: usageplans
      path: /usageplans
      operations:
      - name: createusageplan
        method: POST
        description: Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified
          in the payload.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getusageplans
        method: GET
        description: Gets all the usage plans of the caller's account.
        inputParameters:
        - name: position
          in: query
          type: string
          description: The current pagination position in the paged result set.
        - name: keyId
          in: query
          type: string
          description: The identifier of the API key associated with the usage plans.
        - 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: usageplans-usageplanid-keys
      path: /usageplans/{usageplanId}/keys
      operations:
      - name: createusageplankey
        method: POST
        description: Creates a usage plan key for adding an existing API key to a usage plan.
        inputParameters:
        - name: usageplanId
          in: path
          type: string
          required: true
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey
            resource representing a plan customer.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getusageplankeys
        method: GET
        description: Gets all the usage plan keys representing the API keys added to a specified usage plan.
        inputParameters:
        - name: usageplanId
          in: path
          type: string
          required: true
          description: The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey
            resource representing a plan customer.
        - 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: name
          in: query
          type: string
          description: A query parameter specifying the name of the to-be-returned usage plan keys.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: vpclinks
      path: /vpclinks
      operations:
      - name: createvpclink
        method: POST
        description: Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that
          typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update
          VPC Endpoint servic
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getvpclinks
        method: GET
        description: Gets the VpcLinks collection under the caller's account in a selected region.
        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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: apikeys-api-key
      path: /apikeys/{api_Key}
      operations:
      - name: deleteapikey
        method: DELETE
        description: Deletes the ApiKey resource.
        inputParameters:
        - name: api_Key
          in: path
          type: string
          required: true
          description: The identifier of the ApiKey resource to be deleted.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getapikey
        method: GET
        description: Gets information about the current ApiKey resource.
        inputParameters:
        - name: api_Key
          in: path
          type: string
          required: true
          description: The identifier of the ApiKey resource.
        - name: includeValue
          in: query
          type: boolean
          description: A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains
            the key value.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateapikey
        method: PATCH
        description: Changes information about an ApiKey resource.
        inputParameters:
        - name: api_Key
          in: path
          type: string
          required: true
          description: The identifier of the ApiKey resource to be updated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: authorizer_id
          in: path
          type: string
          required: true
          description: The identifier of the Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getauthorizer
        method: GET
        description: Describe an existing Authorizer resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: authorizer_id
          in: path
          type: string
          required: true
          description: The identifier of the Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: testinvokeauthorizer
        method: POST
        description: Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request
          body.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: authorizer_id
          in: path
          type: string
          required: true
          description: Specifies a test invoke authorizer request's Authorizer ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateauthorizer
        method: PATCH
        description: Updates an existing Authorizer resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: authorizer_id
          in: path
          type: string
          required: true
          description: The identifier of the Authorizer resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: domainnames-domain-name-basepathmappings-base-pa
      path: /domainnames/{domain_name}/basepathmappings/{base_path}
      operations:
      - name: deletebasepathmapping
        method: DELETE
        description: Deletes the BasePathMapping resource.
        inputParameters:
        - name: domain_name
          in: path
          type: string
          required: true
          description: The domain name of the BasePathMapping resource to delete.
        - name: base_path
          in: path
          type: string
          required: true
          description: <p>The base path name of the BasePathMapping resource to delete.</p> <p>To specify an empty base path,
            set this parameter to <code>'(none)'</code>.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getbasepathmapping
        method: GET
        description: Describe a BasePathMapping resource.
        inputParameters:
        - name: domain_name
          in: path
          type: string
          required: true
          description: The domain name of the BasePathMapping resource to be described.
        - name: base_path
          in: path
          type: string
          required: true
          description: The base path name that callers of the API must provide as part of the URL after the domain name. This
            value must be unique for all of the mappings across a sin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebasepathmapping
        method: PATCH
        description: Changes information about the BasePathMapping resource.
        inputParameters:
        - name: domain_name
          in: path
          type: string
          required: true
          description: The domain name of the BasePathMapping resource to change.
        - name: base_path
          in: path
          type: string
          required: true
          description: <p>The base path of the BasePathMapping resource to change.</p> <p>To specify an empty base path, set
            this parameter to <code>'(none)'</code>.</p>
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: clientcertificates-clientcertificate-id
      path: /clientcertificates/{clientcertificate_id}
      operations:
      - name: deleteclientcertificate
        method: DELETE
        description: Deletes the ClientCertificate resource.
        inputParameters:
        - name: clientcertificate_id
          in: path
          type: string
          required: true
          description: The identifier of the ClientCertificate resource to be deleted.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getclientcertificate
        method: GET
        description: Gets information about the current ClientCertificate resource.
        inputParameters:
        - name: clientcertificate_id
          in: path
          type: string
          required: true
          description: The identifier of the ClientCertificate resource to be described.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateclientcertificate
        method: PATCH
        description: Changes information about an ClientCertificate resource.
        inputParameters:
        - name: clientcertificate_id
          in: path
          type: string
          required: true
          description: The identifier of the ClientCertificate resource to be updated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: deployment_id
          in: path
          type: string
          required: true
          description: The identifier of the Deployment resource to delete.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdeployment
        method: GET
        description: Gets information about a Deployment resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: deployment_id
          in: path
          type: string
          required: true
          description: The identifier of the Deployment resource to get information about.
        - 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> '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedeployment
        method: PATCH
        description: Changes information about a Deployment resource.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: deployment_id
          in: path
          type: string
          required: true
          description: The replacement identifier for the Deployment resource to change information about.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - 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
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: part_id
          in: path
          type: string
          required: true
          description: The identifier of the to-be-deleted documentation part.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getdocumentationpart
        method: GET
        description: Gets a documentation part.
        inputParameters:
        - name: restapi_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        - name: part_id
          in: path
          type: string
          required: true
          description: The string identifier of the associated RestApi.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedocumentationpart
        method: PATCH
        descri

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