Cloudflare User API

The User API from Cloudflare — 28 operation(s) for user.

Documentation

📖
Documentation
https://developers.cloudflare.com/api/
📖
GettingStarted
https://developers.cloudflare.com/fundamentals/api/get-started/
📖
Authentication
https://developers.cloudflare.com/fundamentals/api/get-started/create-token/
📖
RateLimits
https://developers.cloudflare.com/fundamentals/api/reference/limits/
📖
Documentation
https://developers.cloudflare.com/api/operations/accounts-list-accounts
📖
APIReference
https://developers.cloudflare.com/api/resources/accounts/
📖
APIReference
https://developers.cloudflare.com/ssl/
📖
Documentation
https://developers.cloudflare.com/api/operations/ip-access-rules-for-a-user-list-ip-access-rules
📖
Documentation
https://developers.cloudflare.com/api/operations/user'-s-account-memberships-list-memberships
📖
Documentation
https://developers.cloudflare.com/api/operations/radar-get-search-global
📖
APIReference
https://developers.cloudflare.com/radar/
📖
GettingStarted
https://developers.cloudflare.com/radar/get-started/
📖
Documentation
https://developers.cloudflare.com/api/operations/user-user-details
📖
APIReference
https://developers.cloudflare.com/api/resources/user/
📖
Documentation
https://developers.cloudflare.com/api/operations/zones-get
📖
APIReference
https://developers.cloudflare.com/api/resources/zones/
📖
Documentation
https://developers.cloudflare.com/dns/
📖
APIReference
https://developers.cloudflare.com/api/resources/dns/
📖
Documentation
https://developers.cloudflare.com/workers/
📖
APIReference
https://developers.cloudflare.com/api/resources/workers/
📖
GettingStarted
https://developers.cloudflare.com/workers/get-started/
📖
Documentation
https://developers.cloudflare.com/workers-ai/
📖
GettingStarted
https://developers.cloudflare.com/workers-ai/get-started/rest-api/
📖
APIReference
https://developers.cloudflare.com/workers-ai/configuration/open-ai-compatibility/
📖
APIReference
https://developers.cloudflare.com/workers-ai/models/
📖
Documentation
https://developers.cloudflare.com/ai-gateway/
📖
APIReference
https://developers.cloudflare.com/ai-gateway/usage/providers/
📖
GettingStarted
https://developers.cloudflare.com/ai-gateway/get-started/
📖
Documentation
https://developers.cloudflare.com/r2/
📖
APIReference
https://developers.cloudflare.com/r2/api/s3/api/
📖
GettingStarted
https://developers.cloudflare.com/r2/get-started/
📖
Documentation
https://developers.cloudflare.com/d1/
📖
APIReference
https://developers.cloudflare.com/api/resources/d1/
📖
GettingStarted
https://developers.cloudflare.com/d1/get-started/
📖
Documentation
https://developers.cloudflare.com/kv/
📖
APIReference
https://developers.cloudflare.com/api/resources/kv/
📖
GettingStarted
https://developers.cloudflare.com/kv/get-started/
📖
Documentation
https://developers.cloudflare.com/queues/
📖
APIReference
https://developers.cloudflare.com/api/resources/queues/
📖
GettingStarted
https://developers.cloudflare.com/queues/get-started/
📖
Documentation
https://developers.cloudflare.com/durable-objects/
📖
GettingStarted
https://developers.cloudflare.com/durable-objects/get-started/
📖
APIReference
https://developers.cloudflare.com/durable-objects/api/
📖
Documentation
https://developers.cloudflare.com/vectorize/
📖
GettingStarted
https://developers.cloudflare.com/vectorize/get-started/intro/
📖
APIReference
https://developers.cloudflare.com/vectorize/reference/client-api/
📖
Documentation
https://developers.cloudflare.com/pages/
📖
APIReference
https://developers.cloudflare.com/pages/configuration/api/
📖
GettingStarted
https://developers.cloudflare.com/pages/get-started/
📖
Documentation
https://developers.cloudflare.com/stream/
📖
GettingStarted
https://developers.cloudflare.com/stream/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/stream/
📖
Documentation
https://developers.cloudflare.com/images/
📖
GettingStarted
https://developers.cloudflare.com/images/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/images/
📖
Documentation
https://developers.cloudflare.com/turnstile/
📖
GettingStarted
https://developers.cloudflare.com/turnstile/get-started/
📖
APIReference
https://developers.cloudflare.com/api/resources/turnstile/
📖
Documentation
https://developers.cloudflare.com/logs/
📖
APIReference
https://developers.cloudflare.com/api/resources/logpush/
📖
GettingStarted
https://developers.cloudflare.com/logs/get-started/
📖
Documentation
https://developers.cloudflare.com/hyperdrive/
📖
APIReference
https://developers.cloudflare.com/api/resources/hyperdrive/
📖
GettingStarted
https://developers.cloudflare.com/hyperdrive/get-started/

Specifications

Other Resources

OpenAPI Specification

cloudflare-user-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Cloudflare / Accounts User API
  description: Needs description.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: User
paths:
  /user:
    get:
      tags:
      - User
      summary: Cloudflare User Details
      operationId: user-user-details
      responses:
        '200':
          description: User Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
        4XX:
          description: User Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_single_user_response'
                - $ref: '#/components/schemas/iam_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - User
      summary: Cloudflare Edit User
      description: Edit part of your user details.
      operationId: user-edit-user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                country:
                  $ref: '#/components/schemas/iam_country'
                first_name:
                  $ref: '#/components/schemas/iam_first_name'
                last_name:
                  $ref: '#/components/schemas/iam_last_name'
                telephone:
                  $ref: '#/components/schemas/iam_telephone'
                zipcode:
                  $ref: '#/components/schemas/iam_zipcode'
      responses:
        '200':
          description: Edit User response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_user_response'
        4XX:
          description: Edit User response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_single_user_response'
                - $ref: '#/components/schemas/iam_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /user/audit_logs:
    get:
      tags:
      - User
      summary: Cloudflare Get user audit logs
      description: Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.
      operationId: audit-logs-get-user-audit-logs
      parameters:
      - name: id
        in: query
        schema:
          type: string
          description: Finds a specific log by its ID.
          example: f174be97-19b1-40d6-954d-70cd5fbd52db
      - name: export
        in: query
        schema:
          type: boolean
          description: Indicates that this request is an export of logs in CSV format.
          example: true
      - name: action.type
        in: query
        schema:
          type: string
          description: Filters by the action type.
          example: add
      - name: actor.ip
        in: query
        schema:
          type: string
          description: Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.
          example: 17.168.228.63
      - name: actor.email
        in: query
        schema:
          type: string
          format: email
          description: Filters by the email address of the actor that made the change.
          example: alice@example.com
      - name: since
        in: query
        schema:
          type: string
          format: date-time
          description: Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.
          example: '2019-04-30T01:12:20Z'
      - name: before
        in: query
        schema:
          type: string
          format: date-time
          description: Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.
          example: '2019-04-30T01:12:20Z'
      - name: zone.name
        in: query
        schema:
          type: string
          description: Filters by the name of the zone associated to the change.
          example: example.com
      - name: direction
        in: query
        schema:
          type: string
          description: Changes the direction of the chronological sorting.
          enum:
          - desc
          - asc
          default: desc
          example: desc
      - name: per_page
        in: query
        schema:
          type: number
          description: Sets the number of results to return per page.
          default: 100
          example: 25
          minimum: 1
          maximum: 1000
      - name: page
        in: query
        schema:
          type: number
          description: Defines which page of results to return.
          default: 1
          example: 50
          minimum: 1
      - name: hide_user_logs
        in: query
        schema:
          type: boolean
          description: Indicates whether or not to hide user level audit logs.
          default: false
      responses:
        '200':
          description: Get user audit logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_audit_logs_response_collection'
        4XX:
          description: Get user audit logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_audit_logs_response_collection'
                - $ref: '#/components/schemas/aaa_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /user/billing/history:
    get:
      tags:
      - User
      summary: Cloudflare Billing History Details
      description: Accesses your billing history object.
      operationId: user-billing-history-(-deprecated)-billing-history-details
      parameters:
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of items per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: order
        in: query
        schema:
          type: string
          description: Field to order billing history by.
          enum:
          - type
          - occured_at
          - action
          example: occured_at
      - name: occured_at
        in: query
        schema:
          $ref: '#/components/schemas/bill-subs-api_occurred_at'
      - name: occurred_at
        in: query
        schema:
          $ref: '#/components/schemas/bill-subs-api_occurred_at'
      - name: type
        in: query
        schema:
          type: string
          description: The billing item type.
          example: charge
          readOnly: true
          maxLength: 30
      - name: action
        in: query
        schema:
          type: string
          description: The billing item action.
          example: subscription
          readOnly: true
          maxLength: 30
      responses:
        '200':
          description: Billing History Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_history_collection'
        4XX:
          description: Billing History Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_billing_history_collection'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/billing/profile:
    get:
      tags:
      - User
      summary: Cloudflare Billing Profile Details
      description: Accesses your billing profile object.
      operationId: user-billing-profile-(-deprecated)-billing-profile-details
      responses:
        '200':
          description: Billing Profile Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_billing_response_single'
        4XX:
          description: Billing Profile Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_billing_response_single'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/firewall/access_rules/rules:
    get:
      tags:
      - User
      summary: Cloudflare List IP Access rules
      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:
      - name: filters
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_schemas-filters'
      - name: egs-pagination.json
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_egs-pagination'
      - name: page
        in: query
        schema:
          type: number
          description: Requested page within paginated list of results.
          example: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Maximum number of results requested.
          example: 20
      - name: order
        in: query
        schema:
          type: string
          description: The field used to sort returned rules.
          enum:
          - configuration.target
          - configuration.value
          - mode
          example: mode
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned rules.
          enum:
          - asc
          - desc
          example: desc
      responses:
        '200':
          description: List IP Access rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_collection_response'
        4xx:
          description: List IP Access rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_collection_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - User
      summary: Cloudflare Create an IP Access rule
      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:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
              properties:
                configuration:
                  $ref: '#/components/schemas/legacy-jhs_schemas-configuration'
                mode:
                  $ref: '#/components/schemas/legacy-jhs_schemas-mode'
                notes:
                  $ref: '#/components/schemas/legacy-jhs_notes'
      responses:
        '200':
          description: Create an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_response'
        4xx:
          description: Create an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/firewall/access_rules/rules/{identifier}:
    delete:
      tags:
      - User
      summary: Cloudflare Delete an IP Access rule
      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:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_id_response'
        4xx:
          description: Delete an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_id_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - User
      summary: Cloudflare Update an IP Access rule
      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:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/legacy-jhs_schemas-mode'
                notes:
                  $ref: '#/components/schemas/legacy-jhs_notes'
      responses:
        '200':
          description: Update an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_response'
        4xx:
          description: Update an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/invites:
    get:
      tags:
      - User
      summary: Cloudflare List Invitations
      description: Lists all invitations associated with my user.
      operationId: user'-s-invites-list-invitations
      responses:
        '200':
          description: List Invitations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_schemas-collection_invite_response'
        4XX:
          description: List Invitations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_schemas-collection_invite_response'
                - $ref: '#/components/schemas/iam_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /user/invites/{invite_id}:
    get:
      tags:
      - User
      summary: Cloudflare Invitation Details
      description: Gets the details of an invitation.
      operationId: user'-s-invites-invitation-details
      parameters:
      - name: invite_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/iam_invite_components-schemas-identifier'
      responses:
        '200':
          description: Invitation Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_invite_response'
        4XX:
          description: Invitation Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_single_invite_response'
                - $ref: '#/components/schemas/iam_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - User
      summary: Cloudflare Respond to Invitation
      description: Responds to an invitation.
      operationId: user'-s-invites-respond-to-invitation
      parameters:
      - name: invite_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/iam_invite_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - status
              properties:
                status:
                  description: Status of your response to the invitation (rejected or accepted).
                  enum:
                  - accepted
                  - rejected
                  example: accepted
      responses:
        '200':
          description: Respond to Invitation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/iam_single_invite_response'
        4XX:
          description: Respond to Invitation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/iam_single_invite_response'
                - $ref: '#/components/schemas/iam_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /user/load_balancers/monitors:
    get:
      tags:
      - User
      summary: Cloudflare List Monitors
      description: List configured monitors for a user.
      operationId: load-balancer-monitors-list-monitors
      responses:
        '200':
          description: List Monitors response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-collection'
        4XX:
          description: List Monitors response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-collection'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - User
      summary: Cloudflare Create Monitor
      description: Create a configured monitor.
      operationId: load-balancer-monitors-create-monitor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
      responses:
        '200':
          description: Create Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
        4XX:
          description: Create Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/load_balancers/monitors/{monitor_id}:
    delete:
      tags:
      - User
      summary: Cloudflare Delete Monitor
      description: Delete a configured monitor.
      operationId: load-balancer-monitors-delete-monitor
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_id_response'
        4XX:
          description: Delete Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_id_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    get:
      tags:
      - User
      summary: Cloudflare Monitor Details
      description: List a single configured monitor for a user.
      operationId: load-balancer-monitors-monitor-details
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        '200':
          description: Monitor Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
        4XX:
          description: Monitor Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - User
      summary: Cloudflare Patch Monitor
      description: Apply changes to an existing monitor, overwriting the supplied properties.
      operationId: load-balancer-monitors-patch-monitor
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
      responses:
        '200':
          description: Patch Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
        4XX:
          description: Patch Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - User
      summary: Cloudflare Update Monitor
      description: Modify a configured monitor.
      operationId: load-balancer-monitors-update-monitor
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
      responses:
        '200':
          description: Update Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_monitor-response-single'
        4XX:
          description: Update Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_monitor-response-single'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/load_balancers/monitors/{monitor_id}/preview:
    post:
      tags:
      - User
      summary: Cloudflare Preview Monitor
      description: Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.
      operationId: load-balancer-monitors-preview-monitor
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/load-balancing_monitor-editable'
              - required:
                - expected_codes
      responses:
        '200':
          description: Preview Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_preview_response'
        4XX:
          description: Preview Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_preview_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/load_balancers/monitors/{monitor_id}/references:
    get:
      tags:
      - User
      summary: Cloudflare List Monitor References
      description: Get the list of resources that reference the provided monitor.
      operationId: load-balancer-monitors-list-monitor-references
      parameters:
      - name: monitor_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_identifier'
      responses:
        '200':
          description: List Monitor References response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_references_response'
        4XX:
          description: List Monitor References response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_references_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /user/load_balancers/pools:
    get:
      tags:
      - User
      summary: Cloudflare List Pools
      description: List configured pools.
      operationId: load-balancer-pools-list-pools
      parameters:
      - name: monitor
        in: query
        schema:
          description: The ID of the Monitor to use for checking the health of origins within this pool.
      responses:
        '200':
          description: List Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
        4XX:
          description: List Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - User
      summary: Cloudflare Patch Pools
      description: Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.
      operationId: load-balancer-pools-patch-pools
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                notification_email:
                  $ref: '#/components/schemas/load-balancing_patch_pools_notification_email'
      responses:
        '200':
          description: Patch Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-response_collection'
        4XX:
          description: Patch Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_schemas-response_collection'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - User
      summary: Cloudflare Create Pool
      description: Create a new pool.
      operationId: load-balancer-pools-create-pool
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - origins
              - name
              properties:
                check_regions:
                  $ref: '#/components/schemas/load-balancing_check_regions'
                description:
                  $ref: '#/components/schemas/load-balancing_schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancing_enabled'
                latitude:
                  $ref: '#/components/schemas/load-balancing_latitude'
                load_shedding:
                  $ref: '#/components/schemas/load-balancing_load_shedding'
                longitude:
                  $ref: '#/components/schemas/load-balancing_longitude'
                minimum_origins:
                  $ref: '#/components/schemas/load-balancing_minimum_origins'
                monitor:
                  $ref: '#/components/schemas/load-balancing_monitor_id'
                name:
                  $ref: '#/components/schemas/load-balancing_name'
                notification_email:
                  $ref: '#/components/schemas/load-balancing_notification_email'
                notification_filter:
                  $ref: '#/components/schemas/load-balancing_notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/load-balancing_origin_steering'
                origins:
                  $ref: '#/components/schemas/load-balancing_origins'
      responses:
        '200':
          description: Create Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_schemas-single_response'
        4XX:
          description: Create Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_schemas-single_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  

# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudflare/refs/heads/main/openapi/cloudflare-user-api-openapi.yml