find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/dnsfilter-user-agent-bulk-updates-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: DNSFilter User Agent Bulk Updates API
  description: '**Note:** If you are a distributor integrating with DNSFilter, please check

    out our Distributors Development Guide.'
  version: '2026-07-13'
servers:
- url: https://api.dnsfilter.com
  description: Production
tags:
- name: User Agent Bulk Updates
  description: ''
paths:
  /v1/user_agent_bulk_updates:
    post:
      tags:
      - User Agent Bulk Updates
      operationId: V1_User_Agent_Bulk_Updates-create
      parameters:
      - name: agent_state
        description: filter by agent state
        required: false
        in: query
        schema:
          type: string
          enum:
          - protected
          - unprotected
          - bypassed
          - uninstalled
      - name: agent_version
        description: Filter user agents by agent version.
        required: false
        in: query
        schema:
          type: string
      - name: block_page_id
        description: Filter user agents by block page ID
        required: false
        in: query
        schema:
          type: integer
      - name: name_search
        description: A search term to search client name fields (i.e. hostname and friendly_name)
        required: false
        in: query
        schema:
          type: string
      - name: network_ids
        description: Networks IDs, defaults to all
        required: false
        in: query
        schema:
          type: array
          items:
            type: integer
        explode: true
      - name: organization_id
        description: Organization ID
        required: false
        in: query
        schema:
          type: integer
      - name: organization_ids
        description: Organization IDs
        required: false
        in: query
        schema:
          type: array
          items:
            type: integer
        explode: true
      - name: policy_id
        description: Filter user agents by policy ID
        required: false
        in: query
        schema:
          type: integer
      - name: policy_schedule
        description: Filter user agents by policy/schedule name
        required: false
        in: query
        schema:
          type: string
      - name: release_channels
        description: 'Filter user agents by release channel. Valid values: stable, beta, preview'
        required: false
        in: query
        schema:
          type: object
          properties:
            value:
              type: string
      - name: scheduled_policy_id
        description: Filter user agents by scheduled_policy ID
        required: false
        in: query
        schema:
          type: integer
      - name: search
        description: 'User agent list by keyword(s) (space delimited), this could be: hostname, friendly name'
        required: false
        in: query
        schema:
          type: string
      - name: state
        description: filter by user agent online/offline state
        required: false
        in: query
        schema:
          type: string
          enum:
          - online
          - offline
      - name: status
        description: 'filter by user agent status, valid attributes: active, disabled, uninstalled'
        required: false
        in: query
        schema:
          type: string
      - name: tags
        description: User agent list by tags
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        explode: true
      - name: traffic_received_last_15_mins
        description: filter by agents that have received traffic in last 15 minutes
        required: false
        in: query
        schema:
          type: boolean
      - name: type
        description: User agent type, defaults to non-proxy/no-relays user agents
        required: false
        in: query
        schema:
          type: string
          enum:
          - proxy
          - agents
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '200':
          description: User agent bulk update
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/UserAgentBulkUpdate'
      description: Create a user agent bulk update.
      summary: Create
      security:
      - header_authorization: []
      x-controller: v1/user_agent_bulk_updates
      x-action: create
      requestBody:
        description: User agent bulk update information, ids overrides filters, exclude_ids removes agents from filtered set
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAgentBulkUpdateCreate'
  /v1/user_agent_bulk_updates/{id}:
    get:
      tags:
      - User Agent Bulk Updates
      operationId: V1_User_Agent_Bulk_Updates-show
      parameters:
      - name: id
        description: Id of user agent bulk update
        required: true
        in: path
        schema:
          type: integer
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '200':
          description: User agent bulk update
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/UserAgentBulkUpdate'
      description: Gets a user agent bulk update by id.
      summary: Show
      security:
      - header_authorization: []
      x-controller: v1/user_agent_bulk_updates
      x-action: show
  /v1/user_agent_bulk_updates/has_mixed:
    post:
      tags:
      - User Agent Bulk Updates
      operationId: V1_User_Agent_Bulk_Updates-has_mixed
      parameters:
      - name: agent_state
        description: filter by agent state
        required: false
        in: query
        schema:
          type: string
          enum:
          - protected
          - unprotected
          - bypassed
          - uninstalled
      - name: name_search
        description: A search term to search client name fields (i.e. hostname and friendly_name)
        required: false
        in: query
        schema:
          type: string
      - name: network_ids
        description: Networks IDs, defaults to all
        required: false
        in: query
        schema:
          type: array
          items:
            type: integer
        explode: true
      - name: organization_ids
        description: Organization IDs, defaults to user organization ID
        required: false
        in: query
        schema:
          type: array
          items:
            type: integer
        explode: true
      - name: search
        description: 'User agent list by keyword(s) (space delimited), this could be: hostname, friendly name'
        required: false
        in: query
        schema:
          type: string
      - name: state
        description: filter by user agent online/offline state
        required: false
        in: query
        schema:
          type: string
          enum:
          - online
          - offline
      - name: status
        description: 'filter by user agent status, valid attributes: active, disabled, uninstalled'
        required: false
        in: query
        schema:
          type: string
      - name: tags
        description: User agent list by tags
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        explode: true
      - name: traffic_received_last_15_mins
        description: filter by agents that have received traffic in last 15 minutes
        required: false
        in: query
        schema:
          type: boolean
      - name: type
        description: User agent type, defaults to non-proxy/no-relays user agents
        required: false
        in: query
        schema:
          type: string
          enum:
          - proxy
          - agents
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '200':
          description: Selected user agents mixed attributes
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/UserAgentBulkUpdateHasMixed'
      description: Gets the value of whether each of the attributes of the elected user agents are mixed.
      summary: Check agent values
      security:
      - header_authorization: []
      x-controller: v1/user_agent_bulk_updates
      x-action: has_mixed
      requestBody:
        description: The user agent bulk selected ids
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserAgentBulkUpdateHasMixedRequest'
  /v1/user_agent_bulk_updates/counts:
    get:
      tags:
      - User Agent Bulk Updates
      operationId: V1_User_Agent_Bulk_Updates-counts
      parameters:
      - name: agent_state
        description: filter by agent state
        required: false
        in: query
        schema:
          type: string
          enum:
          - protected
          - unprotected
          - bypassed
          - uninstalled
      - name: block_page_id
        description: Filter user agents by block page ID
        required: false
        in: query
        schema:
          type: integer
      - name: name_search
        description: A search term to search client name fields (i.e. hostname and friendly_name)
        required: false
        in: query
        schema:
          type: string
      - name: network_ids
        description: Networks IDs, defaults to all
        required: false
        in: query
        schema:
          type: array
          items:
            type: integer
        explode: true
      - name: organization_id
        description: Organization ID
        required: false
        in: query
        schema:
          type: integer
      - name: policy_id
        description: Filter user agents by policy ID
        required: false
        in: query
        schema:
          type: integer
      - name: release_channels
        description: 'Filter user agents by release channel. Valid values: stable, beta, preview'
        required: false
        in: query
        schema:
          type: object
          properties:
            value:
              type: string
      - name: scheduled_policy_id
        description: Filter user agents by scheduled_policy ID
        required: false
        in: query
        schema:
          type: integer
      - name: search
        description: 'User agent list by keyword(s) (space delimited), this could be: hostname, friendly name'
        required: false
        in: query
        schema:
          type: string
      - name: state
        description: filter by user agent online/offline state
        required: false
        in: query
        schema:
          type: string
          enum:
          - online
          - offline
      - name: status
        description: 'filter by user agent status, valid attributes: active, disabled, uninstalled'
        required: false
        in: query
        schema:
          type: string
      - name: tags
        description: User agent list by tags
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        explode: true
      - name: traffic_received_last_15_mins
        description: filter by agents that have received traffic in last 15 minutes
        required: false
        in: query
        schema:
          type: boolean
      - name: type
        description: User agent type, defaults to non-proxy/no-relays user agents
        required: false
        in: query
        schema:
          type: string
          enum:
          - proxy
          - agents
      responses:
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '200':
          description: User agent counts information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAgentBulkDeleteCounts'
      description: Gets a user agent bulk delete counts by id.
      summary: Counts
      security:
      - header_authorization: []
      x-controller: v1/user_agent_bulk_updates
      x-action: counts
components:
  schemas:
    UserAgentBulkUpdateHasMixed:
      type: object
      properties:
        siteMixed:
          type: boolean
          description: true if sites are mixed
        tagsMixed:
          type: boolean
          description: true if tags are mixed
        policyMixed:
          type: boolean
          description: true if policies are mixed
        blockPageMixed:
          type: boolean
          description: true if blockPages are mixed
      description: User agents bulk mixed attribute check
    UserAgentBulkUpdateCreate:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: Ids of user agents to update. Overrides any lookups based on filters
        exclude_ids:
          type: array
          items:
            type: string
          description: Ids of user agents to remove from update when using filters
        changeset:
          $ref: '#/components/schemas/UserAgentBulkUpdateCreateChangeset'
      description: User agent bulk update
    FilteringClientSettingBulkAttributes:
      type: object
      properties:
        connection_method:
          type: string
          enum:
          - unknown
          - transparent_proxy
          - loopback
          description: User agents connection method
        filtering_method:
          type: string
          enum:
          - unknown
          - precheck
          - dns_filtering
          description: User agents filtering method
        fail_over_method:
          type: string
          enum:
          - unknown
          - fail_open
          - fail_close
          description: User agents fail over method
      description: Filtering client setting bulk attributes
    UserAgentBulkDeleteCounts:
      type: object
      properties:
        uninstall_and_delete:
          type: integer
          description: the count of user agents that can bed uninstalled and deleted
        delete:
          type: integer
          description: the count of unsupported user agents that can be deleted
      description: User agent counts by remote uninstall support
    VpnSettingsUserAgentAttributes:
      type: object
      properties:
        _destroy:
          type: boolean
          description: destroy record by setting to true
        vpn_settings_state_type_id:
          type: integer
          description: id for vpn settings state type
      description: VPN settings user agent attributes
    DeviceSettingBulkAttributes:
      type: object
      properties:
        enable_cyber_sight:
          type: boolean
        enable_filtering_client:
          type: boolean
          description: nable_filtering_client [boolean
        diagnostics_level:
          type: string
          enum:
          - unknown
          - trace
          - debug
          - information
          - warning
          - error
          - critical
      description: Device setting bulk attributes
    UserAgentBulkUpdate:
      type: object
      properties:
        organization_id:
          type: integer
          description: Organization resource ID
        completed:
          type: boolean
          description: true if bulk update is completed
        count:
          type: integer
          description: count of affected user agents
      description: User agent bulk update
    UserAgentBulkUpdateCreateChangeset:
      type: object
      properties:
        network_id:
          type: integer
          description: User agent network/site ID, useful to change user agent between networks/sites
        policy_id:
          type: integer
          description: 'Agent custom policy ID, *NOTE*: will be ignored and unset if *scheduled_policy_id* is set'
        scheduled_policy_id:
          type: integer
          description: Agent custom scheduled policy ID
        block_page_id:
          type: integer
          description: Agent custom block page ID
        friendly_name:
          type: string
          description: Agent friendly name (may be null)
        tags:
          type: array
          items:
            type: string
          description: Agent tags
        release_channels:
          type: array
          items:
            type: string
          description: Release channel
        device_setting_attributes:
          $ref: '#/components/schemas/DeviceSettingBulkAttributes'
        filtering_client_setting_attributes:
          $ref: '#/components/schemas/FilteringClientSettingBulkAttributes'
        vpn_settings_user_agent:
          $ref: '#/components/schemas/VpnSettingsUserAgentAttributes'
      description: User agent bulk update changeset
    UserAgentBulkUpdateHasMixedRequest:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
          description: Ids of user agents to use in the
      description: User agents bulk ids
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Error message (e.x.: Not Authorized)'
      description: Error basic representation
  securitySchemes:
    header_authorization:
      type: apiKey
      name: Authorization
      in: header