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: AI Gateway paths: /accounts/{account_id}/ai-gateway/gateways: get: operationId: aig-config-list-gateway parameters: - in: path name: account_id required: true schema: example: 3ebbcb006d4d46d7bb6a8c7f14676cb0 type: string - in: query name: page schema: default: 1 minimum: 1 type: integer - in: query name: per_page schema: default: 20 maximum: 100 minimum: 5 type: integer - description: Order By Column Name in: query name: order_by schema: description: Order By Column Name type: string - description: Order By Direction in: query name: order_by_direction schema: default: asc description: Order By Direction enum: - asc - desc type: string - in: query name: id schema: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string responses: '200': content: application/json: schema: properties: result: items: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean created_at: format: date-time type: string id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string modified_at: format: date-time type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update - created_at - modified_at type: object type: array success: type: boolean required: - success - result type: object description: Returns a list of Gateways '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform List Gateways tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true post: operationId: aig-config-create-gateway parameters: - in: path name: account_id required: true schema: example: 3ebbcb006d4d46d7bb6a8c7f14676cb0 type: string requestBody: content: application/json: schema: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update type: object responses: '200': content: application/json: schema: properties: result: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean created_at: format: date-time type: string id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string modified_at: format: date-time type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update - created_at - modified_at type: object success: type: boolean required: - success - result type: object description: Returns the created Gateway '400': content: application/json: schema: properties: errors: items: properties: code: example: 7001 type: number message: example: Input Validation Error type: string path: items: example: body type: string type: array required: - code - message - path type: object type: array success: type: boolean required: - success - errors type: object description: Input Validation Error security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a new Gateway tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs: get: operationId: aig-config-list-gateway-logs parameters: - in: path name: account_id required: true schema: example: 0d37909e38d3e99c29fa2cd343ac421a type: string - in: path name: gateway_id required: true schema: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string - in: query name: search schema: type: string - in: query name: page schema: default: 1 minimum: 1 type: integer - in: query name: per_page schema: default: 20 maximum: 50 minimum: 5 type: integer - in: query name: order_by schema: default: created_at enum: - created_at - provider - model - model_type - success - cached type: string - in: query name: direction schema: enum: - asc - desc type: string - in: query name: order_by_direction schema: default: asc enum: - asc - desc type: string - in: query name: start_date schema: format: date-time type: string - in: query name: end_date schema: format: date-time type: string - in: query name: min_cost schema: type: number - in: query name: max_cost schema: type: number - in: query name: min_tokens_in schema: type: number - in: query name: max_tokens_in schema: type: number - in: query name: min_tokens_out schema: type: number - in: query name: max_tokens_out schema: type: number - in: query name: min_total_tokens schema: type: number - in: query name: max_total_tokens schema: type: number - in: query name: min_duration schema: type: number - in: query name: max_duration schema: type: number - in: query name: feedback schema: anyOf: - enum: - -1 type: number - enum: - 0 type: number - enum: - 1 type: number - in: query name: success schema: type: boolean - in: query name: cached schema: type: boolean - in: query name: model schema: type: string - in: query name: model_type schema: type: string - in: query name: provider schema: type: string - in: query name: request_content_type schema: type: string - in: query name: response_content_type schema: type: string - in: query name: meta_info schema: type: boolean responses: '200': content: application/json: schema: properties: result: items: properties: cached: type: boolean cost: type: number created_at: format: date-time type: string custom_cost: type: boolean duration: type: integer id: type: string metadata: type: string model: type: string model_type: type: string path: type: string provider: type: string request: type: string request_content_type: type: string request_type: type: string response: type: string response_content_type: type: string status_code: type: integer step: type: integer success: type: boolean tokens_in: nullable: true type: integer tokens_out: nullable: true type: integer required: - id - created_at - provider - model - path - duration - request - response - success - cached - tokens_in - tokens_out type: object type: array result_info: properties: count: type: number max_cost: type: number max_duration: type: number max_tokens_in: type: number max_tokens_out: type: number max_total_tokens: type: number min_cost: type: number min_duration: type: number min_tokens_in: type: number min_tokens_out: type: number min_total_tokens: type: number page: type: number per_page: type: number total_count: type: number type: object success: type: boolean required: - success - result - result_info type: object description: Returns a list of Gateway Logs '400': content: application/json: schema: properties: errors: items: properties: message: type: string required: - message type: object type: array result: type: object success: example: false type: boolean required: - result - success - errors type: object description: Bad Request security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform List Gateway Logs tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/ai-gateway/gateways/{id}: delete: operationId: aig-config-delete-gateway parameters: - in: path name: account_id required: true schema: example: 3ebbcb006d4d46d7bb6a8c7f14676cb0 type: string - in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: result: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean created_at: format: date-time type: string id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string modified_at: format: date-time type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update - created_at - modified_at type: object success: type: boolean required: - success - result type: object description: Returns if the Gateway was deleted successfully '404': content: application/json: schema: properties: errors: items: properties: code: example: 7002 type: number message: example: Not Found type: string required: - code - message type: object type: array success: type: boolean required: - success - errors type: object description: Not Found security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete a Gateway tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true get: operationId: aig-config-fetch-gateway parameters: - in: path name: account_id required: true schema: example: 3ebbcb006d4d46d7bb6a8c7f14676cb0 type: string - in: path name: id required: true schema: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string responses: '200': content: application/json: schema: properties: result: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean created_at: format: date-time type: string id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string modified_at: format: date-time type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update - created_at - modified_at type: object success: type: boolean required: - success - result type: object description: Returns a single Gateway if found '404': content: application/json: schema: properties: errors: items: properties: code: example: 7002 type: number message: example: Not Found type: string required: - code - message type: object type: array success: type: boolean required: - success - errors type: object description: Not Found security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Fetch a Gateway tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true put: operationId: aig-config-update-gateway parameters: - in: path name: account_id required: true schema: example: 3ebbcb006d4d46d7bb6a8c7f14676cb0 type: string - in: path name: id required: true schema: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string requestBody: content: application/json: schema: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update type: object responses: '200': content: application/json: schema: properties: result: properties: cache_invalidate_on_update: type: boolean cache_ttl: minimum: 0 nullable: true type: integer collect_logs: type: boolean created_at: format: date-time type: string id: description: gateway id example: my-gateway maxLength: 64 minLength: 1 pattern: ^[a-z0-9_]+(?:-[a-z0-9_]+)*$ type: string modified_at: format: date-time type: string rate_limiting_interval: minimum: 0 nullable: true type: integer rate_limiting_limit: minimum: 0 nullable: true type: integer rate_limiting_technique: enum: - fixed - sliding type: string required: - id - rate_limiting_interval - rate_limiting_limit - rate_limiting_technique - collect_logs - cache_ttl - cache_invalidate_on_update - created_at - modified_at type: object success: type: boolean required: - success - result type: object description: Returns the updated Gateway '400': content: application/json: schema: properties: errors: items: properties: code: example: 7001 type: number message: example: Input Validation Error type: string path: items: example: body type: string type: array required: - code - message - path type: object type: array success: type: boolean required: - success - errors type: object description: Input Validation Error '404': content: application/json: schema: properties: errors: items: properties: code: example: 7002 type: number message: example: Not Found type: string required: - code - message type: object type: array success: type: boolean required: - success - errors type: object description: Not Found security: - api_token: [] - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update a Gateway tags: - AI Gateway x-cfPermissionsRequired: enum: - com.cloudflare.api.account.aig x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: 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