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.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Licenses description: View various OSS licenses. paths: /licenses: get: summary: APIs.io Engineering Platform Get all commonly used licenses description: Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - Licenses operationId: licenses/get-all-commonly-used externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-all-commonly-used-licenses parameters: - name: featured in: query required: false schema: type: boolean - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/license-simple' examples: default: $ref: '#/components/examples/license-simple-items' '304': $ref: '#/components/responses/not_modified' x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses /licenses/{license}: get: summary: APIs.io Engineering Platform Get a license description: Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." tags: - Licenses operationId: licenses/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-a-license parameters: - name: license in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/license' examples: default: $ref: '#/components/examples/license' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' '304': $ref: '#/components/responses/not_modified' x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses /repos/{owner}/{repo}/license: get: summary: APIs.io Engineering Platform Get the license for a repository description: 'This method returns the contents of the repository''s license file, if one is detected. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub''s open-source [Markup library](https://github.com/github/markup).' tags: - Licenses operationId: licenses/get-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/licenses/licenses#get-the-license-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/license-content' examples: default: $ref: '#/components/examples/license-content' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: licenses subcategory: licenses components: responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' not_modified: description: Not modified schemas: basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id nullable: true license: title: License description: License type: object properties: key: type: string example: mit name: type: string example: MIT License spdx_id: type: string example: MIT nullable: true url: type: string format: uri example: https://api.github.com/licenses/mit nullable: true node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri example: http://choosealicense.com/licenses/mit/ description: type: string example: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. implementation: type: string example: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. permissions: type: array example: - commercial-use - modifications - distribution - sublicense - private-use items: type: string conditions: type: array example: - include-copyright items: type: string limitations: type: array example: - no-liability items: type: string body: type: string example: ' The MIT License (MIT) Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ' featured: type: boolean example: true required: - key - name - url - spdx_id - node_id - html_url - description - implementation - permissions - conditions - limitations - body - featured license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id license-content: title: License Content description: License Content type: object properties: name: type: string path: type: string sha: type: string size: type: integer url: type: string format: uri html_url: type: string format: uri nullable: true git_url: type: string format: uri nullable: true download_url: type: string format: uri nullable: true type: type: string content: type: string encoding: type: string _links: type: object properties: git: type: string format: uri nullable: true html: type: string format: uri nullable: true self: type: string format: uri required: - git - html - self license: $ref: '#/components/schemas/nullable-license-simple' required: - _links - git_url - html_url - download_url - name - path - sha - size - type - url - content - encoding - license parameters: repo: name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string per-page: name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 page: name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 examples: license-content: value: name: LICENSE path: LICENSE sha: 401c59dcc4570b954dd6d345e76199e1f4e76266 size: 1077 url: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master html_url: https://github.com/benbalter/gman/blob/master/LICENSE git_url: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 download_url: https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true type: file content: 'VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu IEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv ZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0 aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls ZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg d2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh dGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg cHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg Y29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z IHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK c3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv dmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj ZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50 aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ UyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL SU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ TUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG SVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO R0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ UklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF UyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G IENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP VVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU SEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K ' encoding: base64 _links: self: https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master git: https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266 html: https://github.com/benbalter/gman/blob/master/LICENSE license: key: mit name: MIT License spdx_id: MIT url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== license-simple-items: value: - key: mit name: MIT License spdx_id: MIT url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== - key: lgpl-3.0 name: GNU Lesser General Public License v3.0 spdx_id: LGPL-3.0 url: https://api.github.com/licenses/lgpl-3.0 node_id: MDc6TGljZW5zZW1pdA== - key: mpl-2.0 name: Mozilla Public License 2.0 spdx_id: MPL-2.0 url: https://api.github.com/licenses/mpl-2.0 node_id: MDc6TGljZW5zZW1pdA== - key: agpl-3.0 name: GNU Affero General Public License v3.0 spdx_id: AGPL-3.0 url: https://api.github.com/licenses/agpl-3.0 node_id: MDc6TGljZW5zZW1pdA== - key: unlicense name: The Unlicense spdx_id: Unlicense url: https://api.github.com/licenses/unlicense node_id: MDc6TGljZW5zZW1pdA== - key: apache-2.0 name: Apache License 2.0 spdx_id: Apache-2.0 url: https://api.github.com/licenses/apache-2.0 node_id: MDc6TGljZW5zZW1pdA== - key: gpl-3.0 name: GNU General Public License v3.0 spdx_id: GPL-3.0 url: https://api.github.com/licenses/gpl-3.0 node_id: MDc6TGljZW5zZW1pdA== license: value: key: mit name: MIT License spdx_id: MIT url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== html_url: http://choosealicense.com/licenses/mit/ description: A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. implementation: Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. permissions: - commercial-use - modifications - distribution - sublicense - private-use conditions: - include-copyright limitations: - no-liability body: ' The MIT License (MIT) Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ' featured: true securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apigateway/ x-hasEquivalentPaths: true