APIs.io Engineering Platform Cloudflare IPs API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Cloudflare IPs API
  version: 4.0.0
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_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_ipv6_cidrs:
      description: List of Cloudflare IPv6 CIDR addresses.
      items:
        description: IPv6 CIDR.
        example: 2400:cb00::/32
        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-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_ipv4_cidrs:
      description: List of Cloudflare IPv4 CIDR addresses.
      items:
        description: IPv4 CIDR.
        example: 199.27.128.0/21
        type: string
      type: array
    addressing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/addressing_api-response-common'
      type: object
    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
    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
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    addressing_etag:
      description: A digest of the IP data. Useful for determining if the data has changed.
      example: a8e453d9d129a3769407127936edfdb0
      type: string
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey