openapi: 3.0.0 info: version: 2015-07-09 x-release: v4 title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Lists API description: Amazon API Gateway

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: Lists paths: /accounts/{account_id}/rules/lists: get: description: Fetches all lists in the account. operationId: lists-get-lists parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Get lists response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_lists-response-collection' description: Get lists response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get lists tags: - Lists x-api-token-group: - Account Rule Lists Write - Account Rule Lists Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true post: description: Creates a new list of the specified type. operationId: lists-create-a-list parameters: - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: schema: properties: description: $ref: '#/components/schemas/lists_description' kind: $ref: '#/components/schemas/lists_kind' name: $ref: '#/components/schemas/lists_name' required: - name - kind type: object required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Create a list response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' description: Create a list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create a list tags: - Lists x-api-token-group: - Account Rule Lists Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/rules/lists/{list_id}: delete: description: Deletes a specific list and all its items. operationId: lists-delete-a-list parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: {} required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-delete-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Delete a list response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_list-delete-response-collection' description: Delete a list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete a list tags: - Lists x-api-token-group: - Account Rule Lists Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true get: description: Fetches the details of a list. operationId: lists-get-a-list parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Get a list response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' description: Get a list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get a list tags: - Lists x-api-token-group: - Account Rule Lists Write - Account Rule Lists Read x-cfPlanAvailability: business: true enterprise: true free: true pro: true put: description: Updates the description of a list. operationId: lists-update-a-list parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: schema: properties: description: $ref: '#/components/schemas/lists_description' type: object required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Update a list response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_list-response-collection' description: Update a list response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update a list tags: - Lists x-api-token-group: - Account Rule Lists Write x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_id}/rules/lists/{list_id}/items: delete: description: 'Removes one or more items from a list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.' operationId: lists-delete-list-items parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: schema: properties: items: items: properties: id: $ref: '#/components/schemas/lists_item_id' minItems: 1 type: array type: object required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Delete list items response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' description: Delete list items response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Delete list items tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true get: description: Fetches all the items in the list. operationId: lists-get-list-items parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' - in: query name: cursor schema: description: The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length. example: zzz type: string - in: query name: per_page schema: description: Amount of results to include in each paginated response. A non-negative 32 bit integer. maximum: 500 minimum: 1 type: integer - in: query name: search schema: description: 'A search query to filter returned items. Its meaning depends on the list type: IP addresses must start with the provided string, hostnames and bulk redirects must contain the string, and ASNs must match the string exactly.' example: 1.1.1. type: string responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_items-list-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Get list items response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_items-list-response-collection' description: Get list items response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get list items tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true post: description: 'Appends new items to the list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.' operationId: lists-create-list-items parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/lists_items-update-request-collection' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Create list items response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' description: Create list items response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Create list items tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true put: description: 'Removes all existing items from the list and adds the provided items to the list. This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](/operations/lists-get-bulk-operation-status) endpoint with the returned `operation_id`.' operationId: lists-update-all-list-items parameters: - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_id required: true schema: $ref: '#/components/schemas/lists_identifier' requestBody: content: application/json: schema: $ref: '#/components/schemas/lists_items-update-request-collection' required: true responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_lists-async-response' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Update all list items response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_lists-async-response' description: Update all list items response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Update all list items tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}: get: description: Fetches a list item in the list. operationId: lists-get-a-list-item parameters: - in: path name: item_id required: true schema: $ref: '#/components/schemas/lists_item_id' - in: path name: list_id required: true schema: $ref: '#/components/schemas/lists_list_id' - in: path name: account_identifier required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_item-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Get a list item response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_item-response-collection' description: Get a list item response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get a list item tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true /accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}: get: description: 'Gets the current status of an asynchronous operation on a list. The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.' operationId: lists-get-bulk-operation-status parameters: - in: path name: operation_id required: true schema: $ref: '#/components/schemas/lists_operation_id' - in: path name: account_identifier required: true schema: $ref: '#/components/schemas/lists_identifier' responses: 4XX: content: application/json: schema: allOf: - $ref: '#/components/schemas/lists_bulk-operation-response-collection' - $ref: '#/components/schemas/lists_api-response-common-failure' description: Get bulk operation status response failure '200': content: application/json: schema: $ref: '#/components/schemas/lists_bulk-operation-response-collection' description: Get bulk operation status response security: - api_email: [] api_key: [] summary: APIs.io Engineering Platform Get bulk operation status tags: - Lists x-cfPlanAvailability: business: true enterprise: true free: true pro: true components: schemas: lists_item: example: comment: Private IP address created_on: '2020-01-01T08:00:00Z' id: 2c0fc9fa937b11eaa1b71c4d701ab86e ip: 10.0.0.1 modified_on: '2020-01-10T14:00:00Z' oneOf: - $ref: '#/components/schemas/lists_item_ip' - $ref: '#/components/schemas/lists_item_redirect' - $ref: '#/components/schemas/lists_item_hostname' - $ref: '#/components/schemas/lists_item_asn' properties: asn: $ref: '#/components/schemas/lists_item_asn' comment: $ref: '#/components/schemas/lists_item_comment' created_on: description: The RFC 3339 timestamp of when the item was created. example: '2020-01-01T08:00:00Z' readOnly: true type: string hostname: $ref: '#/components/schemas/lists_item_hostname' id: $ref: '#/components/schemas/lists_list_id' ip: $ref: '#/components/schemas/lists_item_ip' modified_on: description: The RFC 3339 timestamp of when the item was last modified. example: '2020-01-10T14:00:00Z' readOnly: true type: string redirect: $ref: '#/components/schemas/lists_item_redirect' type: object lists_bulk-operation-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: $ref: '#/components/schemas/lists_operation' type: object lists_item_comment: description: An informative summary of the list item. example: Private IP address type: string lists_item_hostname: description: Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-). properties: url_hostname: example: example.com type: string required: - url_hostname lists_item_id: description: The unique ID of the item in the List. example: 34b12448945f11eaa1b71c4d701ab86e type: string lists_operation: properties: completed: description: The RFC 3339 timestamp of when the operation was completed. example: '2020-01-01T08:00:00Z' readOnly: true type: string error: description: A message describing the error when the status is `failed`. example: This list is at the maximum number of items readOnly: true type: string id: $ref: '#/components/schemas/lists_operation_id' status: description: The current status of the asynchronous operation. enum: - pending - running - completed - failed example: failed readOnly: true type: string required: - id - status type: object lists_lists-async-response: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: properties: operation_id: $ref: '#/components/schemas/lists_operation_id' type: object type: object lists_modified_on: description: The RFC 3339 timestamp of when the list was last modified. example: '2020-01-10T14:00:00Z' type: string lists_messages: example: [] items: properties: code: minimum: 1000 type: integer message: type: string required: - code - message type: object uniqueItems: true type: array lists_num_items: description: The number of items in the list. example: 10 type: number lists_list: properties: created_on: $ref: '#/components/schemas/lists_created_on' description: $ref: '#/components/schemas/lists_description' id: $ref: '#/components/schemas/lists_list_id' kind: $ref: '#/components/schemas/lists_kind' modified_on: $ref: '#/components/schemas/lists_modified_on' name: $ref: '#/components/schemas/lists_name' num_items: $ref: '#/components/schemas/lists_num_items' num_referencing_filters: $ref: '#/components/schemas/lists_num_referencing_filters' type: object lists_api-response-common: properties: errors: $ref: '#/components/schemas/lists_messages' messages: $ref: '#/components/schemas/lists_messages' result: anyOf: - type: object - items: {} type: array success: description: Whether the API call was successful enum: - true example: true type: boolean required: - success - errors - messages - result type: object lists_api-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-common' - properties: result: items: {} nullable: true type: array type: object lists_identifier: description: Identifier example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 readOnly: true type: string lists_lists-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: items: allOf: - $ref: '#/components/schemas/lists_list' - required: - id - name - kind - num_items - created_on - modified_on type: object type: array type: object type: object lists_item-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: $ref: '#/components/schemas/lists_item' type: object lists_item_asn: description: A non-negative 32 bit integer example: 5567 type: integer lists_created_on: description: The RFC 3339 timestamp of when the list was created. example: '2020-01-01T08:00:00Z' type: string lists_num_referencing_filters: description: The number of [filters](/operations/filters-list-filters) referencing the list. example: 2 type: number lists_description: description: An informative summary of the list. example: This is a note maxLength: 500 type: string lists_name: description: An informative name for the list. Use this name in filter and rule expressions. example: list1 maxLength: 50 pattern: ^[a-zA-Z0-9_]+$ type: string lists_kind: description: The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). enum: - ip - redirect - hostname - asn example: ip lists_item_ip: description: An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64. example: 10.0.0.1 type: string lists_list-delete-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: properties: id: $ref: '#/components/schemas/lists_item_id' type: object type: object type: object lists_items: items: $ref: '#/components/schemas/lists_item' type: array lists_items-update-request-collection: items: allOf: - properties: asn: $ref: '#/components/schemas/lists_item_asn' comment: $ref: '#/components/schemas/lists_item_comment' hostname: $ref: '#/components/schemas/lists_item_hostname' ip: $ref: '#/components/schemas/lists_item_ip' redirect: $ref: '#/components/schemas/lists_item_redirect' type: object type: array lists_list_id: description: The unique ID of the list. example: 2c0fc9fa937b11eaa1b71c4d701ab86e maxLength: 32 minLength: 32 readOnly: true type: string lists_item_redirect: description: The definition of the redirect. properties: include_subdomains: default: false type: boolean preserve_path_suffix: default: false type: boolean preserve_query_string: default: false type: boolean source_url: example: example.com/arch type: string status_code: default: 301 enum: - 301 - 302 - 307 - 308 type: integer subpath_matching: default: false type: boolean target_url: example: https://archlinux.org/ type: string required: - source_url - target_url lists_operation_id: description: The unique operation ID of the asynchronous action. example: 4da8780eeb215e6cb7f48dd981c4ea02 readOnly: true type: string lists_items-list-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: $ref: '#/components/schemas/lists_items' result_info: properties: cursors: properties: after: example: yyy type: string before: example: xxx type: string type: object type: object type: object lists_list-response-collection: allOf: - $ref: '#/components/schemas/lists_api-response-collection' - properties: result: $ref: '#/components/schemas/lists_list' type: object type: object lists_api-response-common-failure: properties: errors: allOf: - $ref: '#/components/schemas/lists_messages' example: - code: 7003 message: No route for the URI minLength: 1 messages: allOf: - $ref: '#/components/schemas/lists_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 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