# query ip whitelist

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/ip_whitelist/query:
    post:
      summary: query ip whitelist
      deprecated: false
      description: ''
      tags:
        - Rotation proxy/ip whitelist
        - ip whitelist
      parameters:
        - name: Authorization
          in: header
          description: ''
          example: Bearer {{AUTH_TOKEN}}
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  description: required
                  allOf:
                    - type: object
                      properties:
                        id:
                          description: optional, specific record id
                          type: integer
                        ip:
                          description: optional, specific ip
                          type: string
                      x-apifox-refs: {}
                      x-apifox-orders:
                        - id
                        - ip
                from_db:
                  description: from db or cache
                  type: boolean
                limit:
                  description: query quantity for pagination
                  type: integer
                offset:
                  description: query offset for pagination
                  type: integer
              x-apifox-refs: {}
              x-apifox-orders:
                - filter
                - from_db
                - limit
                - offset
              required:
                - from_db
                - filter
            example:
              from_db: true
              filter: {}
              offset: 0
              limit: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        created_unixtime:
                          type: integer
                        id:
                          type: integer
                        ip:
                          type: string
                        tag:
                          type: string
                        user_id:
                          type: integer
                      x-apifox-refs: {}
                      x-apifox-orders:
                        - created_unixtime
                        - id
                        - ip
                        - tag
                        - user_id
                    description: query record result
                  meta_message:
                    type: string
                    description: success or other error msg
                  meta_status:
                    type: integer
                    description: 1 for success, negative for error
                  total_count:
                    type: integer
                    description: total record quantity
                x-apifox-refs: {}
                x-apifox-orders:
                  - data
                  - meta_message
                  - meta_status
                  - total_count
                required:
                  - meta_message
                  - meta_status
                  - total_count
                  - data
          headers: {}
          x-apifox-name: result
      security: []
      x-apifox-folder: Rotation proxy/ip whitelist
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/2880121/apis/api-88999356-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.ipcola.com
    description: ipcola
security: []

```