APIs.io Engineering Platform IP Access Rules for a User 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 IP Access Rules for a User API
  version: 4.0.0
tags:
- name: IP Access Rules for a User
paths:
  /user/firewall/access_rules/rules:
    get:
      description: Fetches IP Access rules of the user. You can filter the results using several optional parameters.
      operationId: ip-access-rules-for-a-user-list-ip-access-rules
      parameters:
      - in: query
        name: mode
        schema:
          $ref: '#/components/schemas/firewall_schemas-mode'
      - in: query
        name: configuration.target
        schema:
          description: The target to search in existing rules.
          enum:
          - ip
          - ip_range
          - asn
          - country
          example: ip
          type: string
      - in: query
        name: configuration.value
        schema:
          description: 'The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.

            Notes: You can search for a single IPv4 address, an IP address range with a subnet of ''/16'' or ''/24'', or a two-letter ISO-3166-1 alpha-2 country code.'
          example: 198.51.100.4
          type: string
      - in: query
        name: notes
        schema:
          description: 'The string to search for in the notes of existing IP Access rules.

            Notes: For example, the string ''attack'' would match IP Access rules with notes ''Attack 26/02'' and ''Attack 27/02''. The search is case insensitive.'
          example: my note
          type: string
      - in: query
        name: match
        schema:
          default: all
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          type: string
      - in: query
        name: page
        schema:
          description: Requested page within paginated list of results.
          example: 1
          type: number
      - in: query
        name: per_page
        schema:
          description: Maximum number of results requested.
          example: 20
          type: number
      - in: query
        name: order
        schema:
          description: The field used to sort returned rules.
          enum:
          - configuration.target
          - configuration.value
          - mode
          example: mode
          type: string
      - in: query
        name: direction
        schema:
          description: The direction used to sort returned rules.
          enum:
          - asc
          - desc
          example: desc
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewall_rule_collection_response'
                - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: List IP Access rules response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_collection_response'
          description: List IP Access rules response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List IP Access rules
      tags:
      - IP Access Rules for a User
      x-api-token-group:
      - Account Firewall Access Rules Write
      - Account Firewall Access Rules Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: 'Creates a new IP Access rule for all zones owned by the current user.


        Note: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.'
      operationId: ip-access-rules-for-a-user-create-an-ip-access-rule
      requestBody:
        content:
          application/json:
            schema:
              properties:
                configuration:
                  $ref: '#/components/schemas/firewall_configuration'
                mode:
                  $ref: '#/components/schemas/firewall_schemas-mode'
                notes:
                  $ref: '#/components/schemas/firewall_notes'
              required:
              - mode
              - configuration
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewall_rule_single_response'
                - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Create an IP Access rule response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_response'
          description: Create an IP Access rule response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an IP Access rule
      tags:
      - IP Access Rules for a User
      x-api-token-group:
      - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /user/firewall/access_rules/rules/{identifier}:
    delete:
      description: 'Deletes an IP Access rule at the user level.


        Note: Deleting a user-level rule will affect all zones owned by the user.'
      operationId: ip-access-rules-for-a-user-delete-an-ip-access-rule
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/firewall_schemas-identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewall_rule_single_id_response'
                - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Delete an IP Access rule response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_id_response'
          description: Delete an IP Access rule response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an IP Access rule
      tags:
      - IP Access Rules for a User
      x-api-token-group:
      - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes.
      operationId: ip-access-rules-for-a-user-update-an-ip-access-rule
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/firewall_schemas-identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/firewall_schemas-mode'
                notes:
                  $ref: '#/components/schemas/firewall_notes'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewall_rule_single_response'
                - $ref: '#/components/schemas/firewall_api-response-common-failure'
          description: Update an IP Access rule response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewall_rule_single_response'
          description: Update an IP Access rule response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an IP Access rule
      tags:
      - IP Access Rules for a User
      x-api-token-group:
      - Account Firewall Access Rules Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    firewall_ipv6_configuration:
      properties:
        target:
          description: The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.
          enum:
          - ip6
          example: ip6
        value:
          description: The IPv6 address to match.
          example: 2001:DB8:100::CF
          type: string
      title: An IPv6 address configuration.
    firewall_schemas-mode:
      description: The action to apply to a matched request.
      enum:
      - block
      - challenge
      - whitelist
      - js_challenge
      - managed_challenge
      example: challenge
      type: string
    firewall_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
    firewall_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    firewall_rule_single_response:
      allOf:
      - $ref: '#/components/schemas/firewall_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/firewall_rule'
    firewall_rule_collection_response:
      allOf:
      - $ref: '#/components/schemas/firewall_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/firewall_rule'
            type: array
    firewall_ip_configuration:
      properties:
        target:
          description: The configuration target. You must set the target to `ip` when specifying an IP address in the rule.
          enum:
          - ip
          example: ip
        value:
          description: The IP address to match. This address will be compared to the IP address of incoming requests.
          example: 198.51.100.4
          type: string
      title: An IP address configuration.
    firewall_api-response-single:
      allOf:
      - $ref: '#/components/schemas/firewall_api-response-common'
      - properties:
          result:
            anyOf:
            - type:
              - object
              - 'null'
            - type:
              - string
              - 'null'
      type: object
    firewall_rule_single_id_response:
      allOf:
      - $ref: '#/components/schemas/firewall_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/firewall_schemas-identifier'
            type: object
    firewall_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/firewall_messages'
        messages:
          $ref: '#/components/schemas/firewall_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    firewall_rule:
      properties:
        allowed_modes:
          description: The available actions that a rule can apply to a matched request.
          example:
          - whitelist
          - block
          - challenge
          - js_challenge
          - managed_challenge
          items:
            $ref: '#/components/schemas/firewall_schemas-mode'
          readOnly: true
          type: array
        configuration:
          $ref: '#/components/schemas/firewall_configuration'
        created_on:
          description: The timestamp of when the rule was created.
          example: '2014-01-01T05:20:00.12345Z'
          format: date-time
          readOnly: true
          type: string
        id:
          $ref: '#/components/schemas/firewall_schemas-identifier'
        mode:
          $ref: '#/components/schemas/firewall_schemas-mode'
        modified_on:
          description: The timestamp of when the rule was last modified.
          example: '2014-01-01T05:20:00.12345Z'
          format: date-time
          readOnly: true
          type: string
        notes:
          $ref: '#/components/schemas/firewall_notes'
      required:
      - id
      - mode
      - allowed_modes
      - configuration
      type: object
    firewall_cidr_configuration:
      properties:
        target:
          description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.
          enum:
          - ip_range
          example: ip_range
        value:
          description: The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.
          example: 198.51.100.4/16
          type: string
      title: An IP address range configuration.
    firewall_notes:
      description: An informative summary of the rule, typically used as a reminder or explanation.
      example: This rule is enabled because of an event that occurred on date X.
      type: string
    firewall_schemas-identifier:
      description: The unique identifier of the IP Access rule.
      example: 92f17202ed8bd63d69a66b86a49a8f6b
      maxLength: 32
      readOnly: true
      type: string
    firewall_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/firewall_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/firewall_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
    firewall_country_configuration:
      properties:
        target:
          description: The configuration target. You must set the target to `country` when specifying a country code in the rule.
          enum:
          - country
          example: country
        value:
          description: 'The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).'
          example: US
          type: string
      title: A country configuration.
    firewall_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/firewall_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/firewall_result_info'
      type: object
    firewall_asn_configuration:
      properties:
        target:
          description: The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.
          enum:
          - asn
          example: asn
        value:
          description: The AS number to match.
          example: AS12345
          type: string
      title: An ASN configuration.
    firewall_configuration:
      description: The rule configuration.
      oneOf:
      - $ref: '#/components/schemas/firewall_ip_configuration'
      - $ref: '#/components/schemas/firewall_ipv6_configuration'
      - $ref: '#/components/schemas/firewall_cidr_configuration'
      - $ref: '#/components/schemas/firewall_asn_configuration'
      - $ref: '#/components/schemas/firewall_country_configuration'
      type: object
  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