APIs.io Engineering Platform Cloudflare IPs API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Cloudflare IPs API
  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>
  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
    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: Cloudflare IPs
paths:
  /ips:
    get:
      description: Get IPs used on the Cloudflare/JD Cloud network, see https://www.cloudflare.com/ips for Cloudflare IPs or https://developers.cloudflare.com/china-network/reference/infrastructure/ for JD Cloud IPs.
      operationId: cloudflare-i-ps-cloudflare-ip-details
      parameters:
      - description: Specified as `jdcloud` to list IPs used by JD Cloud data centers.
        in: query
        name: networks
        schema:
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/addressing_api-response-single'
                  - properties:
                      result:
                        oneOf:
                        - $ref: '#/components/schemas/addressing_ips'
                        - $ref: '#/components/schemas/addressing_ips_jdcloud'
                - $ref: '#/components/schemas/addressing_api-response-common-failure'
          description: Cloudflare IP Details response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/addressing_api-response-single'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/addressing_ips'
                      - $ref: '#/components/schemas/addressing_ips_jdcloud'
          description: Cloudflare IP Details response
      security:
      - {}
      summary: APIs.io Engineering Platform Cloudflare/JD Cloud IP Details
      tags:
      - Cloudflare IPs
components:
  schemas:
    addressing_ipv4_cidrs:
      description: List of Cloudflare IPv4 CIDR addresses.
      items:
        description: IPv4 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    addressing_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    addressing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      type: object
    addressing_jdcloud_cidrs:
      description: List IPv4 and IPv6 CIDRs, only populated if `?networks=jdcloud` is used.
      items:
        description: IPv4 or IPv6 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    addressing_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/addressing_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/addressing_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
    addressing_ipv6_cidrs:
      description: List of Cloudflare IPv6 CIDR addresses.
      items:
        description: IPv6 CIDR.
        example: 2400:cb00::/32
        type: string
      type: array
    addressing_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/addressing_messages'
        messages:
          $ref: '#/components/schemas/addressing_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    addressing_ips:
      properties:
        etag:
          $ref: '#/components/schemas/addressing_etag'
        ipv4_cidrs:
          $ref: '#/components/schemas/addressing_ipv4_cidrs'
        ipv6_cidrs:
          $ref: '#/components/schemas/addressing_ipv6_cidrs'
      type: object
    addressing_etag:
      description: A digest of the IP data. Useful for determining if the data has changed.
      example: a8e453d9d129a3769407127936edfdb0
      type: string
    addressing_ips_jdcloud:
      properties:
        etag:
          $ref: '#/components/schemas/addressing_etag'
        ipv4_cidrs:
          $ref: '#/components/schemas/addressing_ipv4_cidrs'
        ipv6_cidrs:
          $ref: '#/components/schemas/addressing_ipv6_cidrs'
        jdcloud_cidrs:
          $ref: '#/components/schemas/addressing_jdcloud_cidrs'
      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