> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iearena.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Rollout Filters

> Discover rollout filter values and counts, optionally within a job.



## OpenAPI

````yaml /api-sdk/openapi.json get /rollouts/filters
openapi: 3.1.0
info:
  title: Harbor API
  version: '2026-10-30'
  description: The harbor serve API.
servers:
  - url: http://127.0.0.1:{port}
    description: Local server
    variables:
      port:
        default: '8390'
  - url: https://{host}
    description: Remote server
    variables:
      host:
        default: your-server.example.com
security:
  - {}
  - BearerAuth: []
tags:
  - name: Jobs
  - name: Rollouts
  - name: Files
  - name: Queries
paths:
  /rollouts/filters:
    get:
      tags:
        - Queries
      summary: Rollout Filters
      description: Discover rollout filter values and counts, optionally within a job.
      operationId: rollout_filters_rollouts_filters_get
      parameters:
        - name: field
          in: query
          required: true
          schema:
            type: string
            enum:
              - state
              - task
              - agent_name
              - agent_version
              - model_name
              - model_provider
              - reasoning_effort
              - source
            title: Field
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 1000
            minimum: 1
            description: Maximum choices.
            default: 100
            title: Limit
          description: Maximum choices.
        - name: task
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              minLength: 1
              maxLength: 4096
            maxItems: 100
            description: >-
              Task names across versions, or name@sha256:<full digest> pins.
              Repeated values use OR.
            title: Task
          description: >-
            Task names across versions, or name@sha256:<full digest> pins.
            Repeated values use OR.
        - name: state
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - queued
                  - running
                  - paused
                  - cancelling
                  - finished
                  - cancelled
                type: string
              - type: 'null'
            title: State
        - name: name
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            title: Name
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 200
              - type: 'null'
            title: Q
        - name: agent_name
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Agent Name
        - name: agent_version
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Agent Version
        - name: model_name
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Model Name
        - name: model_provider
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Model Provider
        - name: reasoning_effort
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Reasoning Effort
        - name: source
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            maxItems: 100
            title: Source
        - name: created_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: Created After
        - name: created_before
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: Created Before
        - name: job_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Job Id
        - name: Harbor-API-Version
          in: header
          required: false
          schema:
            type: string
            default: '2026-10-30'
            title: Harbor-Api-Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterValuesResponse'
        '422':
          $ref: '#/components/responses/RequestError'
        default:
          $ref: '#/components/responses/RequestError'
      x-codeSamples:
        - lang: python
          label: Harbor SDK
          source: |
            from harbor import Harbor

            client = Harbor()
            result = client.rollout_filters("task", job_id="JOB_ID")
            print(result)
            client.close()
components:
  schemas:
    FilterValuesResponse:
      properties:
        field:
          type: string
          enum:
            - state
            - task
            - agent_name
            - agent_version
            - model_name
            - model_provider
            - reasoning_effort
            - source
          title: Field
        values:
          items:
            $ref: '#/components/schemas/FilterOption'
          type: array
          title: Values
        truncated:
          type: boolean
          title: Truncated
          default: false
      type: object
      required:
        - field
        - values
      title: FilterValuesResponse
    FilterOption:
      properties:
        value:
          type: string
          title: Value
        count:
          type: integer
          title: Count
      type: object
      required:
        - value
        - count
      title: FilterOption
  responses:
    RequestError:
      description: Request rejected. Read error.code and error.message.
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                  message:
                    type: string
                additionalProperties:
                  type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Required only when the server has HARBOR_API_KEY configured.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.