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: Access Custom Pages paths: /accounts/{account_id}/access/custom_pages: get: description: List custom pages operationId: access-custom-pages-list-custom-pages parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' description: List custom pages response failure '200': content: application/json: schema: $ref: '#/components/schemas/access_custom-pages_components-schemas-response_collection' description: List custom pages response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform List custom pages tags: - Access Custom Pages x-api-token-group: - 'Access: Custom Page Write' - 'Access: Custom Page Read' post: description: Create a custom page operationId: access-custom-pages-create-a-custom-page parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/access_custom_page' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' description: Create a custom page response failure '201': content: application/json: schema: $ref: '#/components/schemas/access_single_response_without_html' description: Create a custom page response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a custom page tags: - Access Custom Pages x-api-token-group: - 'Access: Custom Page Write' /accounts/{account_id}/access/custom_pages/{custom_page_id}: delete: description: Delete a custom page operationId: access-custom-pages-delete-a-custom-page parameters: - in: path name: custom_page_id required: true schema: $ref: '#/components/schemas/access_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' description: Delete a custom page response failure '202': content: application/json: schema: $ref: '#/components/schemas/access_components-schemas-id_response' description: Delete a custom page response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete a custom page tags: - Access Custom Pages x-api-token-group: - 'Access: Custom Page Write' get: description: Fetches a custom page and also returns its HTML. operationId: access-custom-pages-get-a-custom-page parameters: - in: path name: custom_page_id required: true schema: $ref: '#/components/schemas/access_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/access_identifier' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' description: Get a custom page response failure '200': content: application/json: schema: $ref: '#/components/schemas/access_custom-pages_components-schemas-single_response' description: Get a custom page response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get a custom page tags: - Access Custom Pages x-api-token-group: - 'Access: Custom Page Write' - 'Access: Custom Page Read' put: description: Update a custom page operationId: access-custom-pages-update-a-custom-page parameters: - in: path name: custom_page_id required: true schema: $ref: '#/components/schemas/access_uuid' - in: path name: account_id required: true schema: $ref: '#/components/schemas/access_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/access_custom_page' responses: 4XX: content: application/json: schema: $ref: '#/components/schemas/access_api-response-common-failure' description: Update a custom page response failure '200': content: application/json: schema: $ref: '#/components/schemas/access_single_response_without_html' description: Update a custom page response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update a custom page tags: - Access Custom Pages x-api-token-group: - 'Access: Custom Page Write' components: schemas: access_custom_page_without_html: properties: app_count: $ref: '#/components/schemas/access_schemas-app_count' created_at: $ref: '#/components/schemas/access_timestamp' name: $ref: '#/components/schemas/access_custom-pages_components-schemas-name' type: $ref: '#/components/schemas/access_schemas-type' uid: $ref: '#/components/schemas/access_uuid' updated_at: $ref: '#/components/schemas/access_timestamp' required: - name - type type: object access_schemas-app_count: description: Number of apps the custom page is assigned to. type: integer access_api-response-common: properties: errors: $ref: '#/components/schemas/access_messages' messages: $ref: '#/components/schemas/access_messages' success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages type: object access_result_info: properties: count: description: Total number of results for the requested service example: 1 type: number page: description: Current page within paginated list of results example: 1 type: number per_page: description: Number of results per page of results example: 20 type: number total_count: description: Total results available without any search parameters example: 2000 type: number type: object access_custom-pages_components-schemas-name: description: Custom page name. type: string access_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/access_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/access_messages' example: [] result: enum: - null nullable: true type: object success: description: Whether the API call was successful enum: - false example: false type: boolean required: - success - errors - messages - result type: object access_schemas-type: description: Custom page type. enum: - identity_denied - forbidden type: string access_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array access_single_response_without_html: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_custom_page_without_html' access_api-response-collection: allOf: - $ref: '#/components/schemas/access_api-response-common' - properties: result_info: $ref: '#/components/schemas/access_result_info' type: object access_custom-pages_components-schemas-single_response: allOf: - $ref: '#/components/schemas/access_api-response-single' - properties: result: $ref: '#/components/schemas/access_custom_page' access_components-schemas-id_response: allOf: - $ref: '#/components/schemas/access_api-response-common' - properties: result: properties: id: $ref: '#/components/schemas/access_uuid' type: object access_uuid: description: UUID example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 maxLength: 36 type: string access_custom_page: properties: app_count: $ref: '#/components/schemas/access_schemas-app_count' created_at: $ref: '#/components/schemas/access_timestamp' custom_html: description: Custom page HTML. example: