Harness Registry V3 - Filters API

openapi: 3.2.0
info:
  title: Harness Registry V3 - Filters API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:
- name: Registry V3 - Filters
paths:
  /har/api/v3/filters:
    get:
      description: 'List filter definitions available for the requested `resource_type`

        (REGISTRY, PACKAGE, or VERSION).


        Filters returned depend on the scope inferred from the supplied

        identifiers (ACCOUNT / ORG / PROJECT). For PACKAGE and VERSION

        resource types, if `package_type` is provided the response is

        augmented with type-specific filters (e.g. Docker, Maven, npm).

        `package_type` is ignored when `resource_type=REGISTRY`.'
      operationId: ListFiltersV3
      parameters:
      - $ref: '#/components/parameters/AccountIdentifierV3'
      - $ref: '#/components/parameters/OrgIdentifierV3'
      - $ref: '#/components/parameters/ProjectIdentifierV3'
      - $ref: '#/components/parameters/FilterResourceTypeParamV3'
      - $ref: '#/components/parameters/PackageTypeFilterParamV3'
      - $ref: '#/components/parameters/FilterIdOptionalParamV3'
      - $ref: '#/components/parameters/SearchTermV3'
      responses:
        '200':
          $ref: '#/components/responses/ListFiltersResponseV3'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorV3'
          description: Error response.
      summary: List Filters
      tags:
      - Registry V3 - Filters
      x-internal: false
  /har/api/v3/filters/options:
    get:
      description: 'List the selectable values for a single filter identified by

        `filter_id`. Same authorization and scoping semantics as

        `GET /filters`. `package_type` is only meaningful for filters on

        PACKAGE and VERSION resources and is ignored otherwise;

        `search_term` narrows the returned options in place of

        pagination.'
      operationId: ListFilterOptionsV3
      parameters:
      - $ref: '#/components/parameters/AccountIdentifierV3'
      - $ref: '#/components/parameters/OrgIdentifierV3'
      - $ref: '#/components/parameters/ProjectIdentifierV3'
      - $ref: '#/components/parameters/FilterResourceTypeParamV3'
      - $ref: '#/components/parameters/FilterIdParamV3'
      - $ref: '#/components/parameters/PackageTypeFilterParamV3'
      - $ref: '#/components/parameters/OptionValuesParamV3'
      - $ref: '#/components/parameters/SearchTermV3'
      responses:
        '200':
          $ref: '#/components/responses/ListFilterOptionsResponseV3'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorV3'
          description: Error response.
      summary: List Filter Options
      tags:
      - Registry V3 - Filters
      x-internal: false
components:
  parameters:
    SearchTermV3:
      description: 'Search term for filtering results.


        Example: `search_term=prod` might match keys like "production", "prod-env", etc.

        '
      in: query
      name: search_term
      schema:
        type: string
    FilterIdOptionalParamV3:
      description: 'Optional filter identifier. When provided, returns only the

        filter definition matching this id.

        '
      in: query
      name: filter_id
      schema:
        type: string
    OptionValuesParamV3:
      description: 'Optional list of option values. When provided, returns only the

        options whose values match one of the supplied values.

        '
      in: query
      name: option_values
      schema:
        items:
          type: string
        type: array
      style: form
    PackageTypeFilterParamV3:
      description: Filter by package type
      in: query
      name: package_type
      schema:
        type: string
    ProjectIdentifierV3:
      description: 'Unique identifier for the project within the organization.


        Example: `my_project` or `frontend_services`

        '
      in: query
      name: project_identifier
      schema:
        type: string
    AccountIdentifierV3:
      description: 'Unique identifier for the Harness account.

        '
      in: query
      name: account_identifier
      required: true
      schema:
        type: string
    FilterResourceTypeParamV3:
      description: 'Resource type whose filter definitions should be returned.

        '
      in: query
      name: resource_type
      required: true
      schema:
        $ref: '#/components/schemas/FilterResourceTypeV3'
    FilterIdParamV3:
      description: 'Identifier of the filter whose selectable options should be

        returned. Matches `FilterDefinitionV3.id` from

        `GET /filters`, including namespaced ids for dynamic filters

        (e.g. `metadata.env`).

        '
      in: query
      name: filter_id
      required: true
      schema:
        type: string
    OrgIdentifierV3:
      description: 'Unique identifier for the organization within the account.


        Example: `default` or `engineering_org`

        '
      in: query
      name: org_identifier
      schema:
        type: string
  schemas:
    ApiErrorsV3:
      properties:
        code:
          description: For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
          maxLength: 5000
          type: string
        message:
          description: A human-readable message providing more details about the error. These messages can be shown to users.
          maxLength: 40000
          type: string
        param:
          description: If the error is parameter-specific, the parameter related to the error. For example, we can use this to display a message near the correct form field.
          maxLength: 5000
          type: string
        type:
          description: The type of error returned.
          enum:
          - INVALID_REQUEST_ERROR
          - AUTHENTICATION_ERROR
          - PERMISSION_ERROR
          - API_ERROR
          type: string
      required:
      - type
      title: APIErrors
      type: object
    ListFiltersResponseBodyV3:
      description: 'Response body for a list filters query. Contains a single merged

        list of filter definitions — static filters (from configuration)

        followed by dynamic metadata filters (one per user-defined

        metadata key, identified by `metadata.<key>`). The list is

        capped server-side (currently at 100 dynamic entries) and is not

        paginated; `search_term` narrows both static and dynamic

        entries.

        '
      properties:
        filters:
          description: 'Combined filter definitions available for the requested

            `resource_type`, in a stable order: static filters first

            (in configured order), followed by dynamic metadata filters.

            '
          items:
            $ref: '#/components/schemas/FilterDefinitionV3'
          type: array
      required:
      - filters
      type: object
    FilterResourceTypeV3:
      description: 'Resource type whose filter definitions are requested by

        `GET /filters?resource_type=...`.

        '
      enum:
      - REGISTRY
      - PACKAGE
      - VERSION
      type: string
    FilterDefinitionV3:
      description: Definition of a filter that can be applied when listing a resource.
      properties:
        conditions:
          description: Comparison conditions supported by this filter.
          items:
            $ref: '#/components/schemas/FilterConditionV3'
          type: array
        dataType:
          $ref: '#/components/schemas/FilterDataTypeV3'
        field:
          description: Backend field name the filter maps to.
          type: string
        id:
          description: Stable identifier for the filter.
          type: string
        inputType:
          $ref: '#/components/schemas/FilterInputTypeV3'
        label:
          description: Human-readable label for the filter.
          type: string
        supportsOptions:
          description: Whether the filter supports a dynamic set of option values.
          type: boolean
      required:
      - id
      - label
      - field
      - dataType
      - inputType
      - conditions
      - supportsOptions
      type: object
    FilterConditionV3:
      description: Supported comparison condition for a filter.
      enum:
      - EQ
      - NE
      - GT
      - LT
      - CONTAINS
      - STARTS_WITH
      - ENDS_WITH
      - IN
      - NOT_IN
      type: string
    FilterOptionV3:
      description: One selectable value for a filter with `supportsOptions=true`.
      properties:
        label:
          description: Human-readable label for the value.
          type: string
        value:
          description: Value to send back when applying the filter.
          type: string
      required:
      - value
      - label
      type: object
    FilterDataTypeV3:
      description: Data type of a filter field.
      enum:
      - string
      - number
      - boolean
      type: string
    ErrorV3:
      description: An error response
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorsV3'
      required:
      - error
      type: object
    ListFilterOptionsResponseBodyV3:
      description: 'Response body for `GET /filters/options`. Returns the set of

        selectable values for a single filter. The list is bounded

        server-side; `search_term` narrows it in place of pagination.

        '
      properties:
        options:
          description: Selectable values for the requested filter.
          items:
            $ref: '#/components/schemas/FilterOptionV3'
          type: array
      required:
      - options
      type: object
    FilterInputTypeV3:
      description: UI input control used to render a filter field.
      enum:
      - text
      - number
      - checkbox
      - singleSelect
      - multiSelect
      type: string
  responses:
    ListFilterOptionsResponseV3:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListFilterOptionsResponseBodyV3'
      description: response for list filter options
    ListFiltersResponseV3:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListFiltersResponseBodyV3'
      description: response for list filters
  securitySchemes:
    x-api-key:
      name: x-api-key
      type: apiKey
      in: header
      description: API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
x-stoplight:
  id: oc91t4vrfnjyi
x-tagGroups:
- name: Organizations
  tags:
  - Organization
- name: Projects
  tags:
  - Org Project
  - Project
- name: Secrets
  tags:
  - Account Secret
  - Org Secret
  - Project Secret
  - Secrets
- name: Connectors
  tags:
  - Account Connector
  - Org Connector
  - Project Connector
  - Connectors
  - GoogleSecretManagerConnector
- name: Roles
  tags:
  - Account Roles
  - Organization Roles
  - Project Roles
  - Roles
- name: Resource Groups
  tags:
  - Account Resource Groups
  - Organization Resource Groups
  - Project Resource Groups
  - Filter Resource Groups
  - Harness Resource Group
  - Zendesk
- name: Role Assignments
  tags:
  - Account Role Assignments
  - Org Role Assignments
  - Project Role Assignments
  - Role Assignments
- name: Platform
  tags:
  - Access Control List
  - Account Banner
  - Account Banner
  - Account Licensed Modules
  - Account License Type
  - Account Webhooks
  - AccountSetting
  - Accounts
  - Analyze Account Access Policy
  - Analyze Organization Access Policy
  - Analyze Project Access Policy
  - ApiKey
  - Audit
  - AuditFilters
  - Authentication Settings
  - Canny
  - Devops Essentials License Data By Account
  - EULA
  - Filter
  - Harness Resource Type
  - Invite
  - IP Allowlist
  - Nextgen Ldap
  - Notification Channels
  - Notification Rules
  - OIDC
  - Oidc-Access-Token
  - Oidc-ID-Token
  - Org Webhooks
  - Permissions
  - Project Webhooks
  - Secret Managers
  - Service Account
  - Setting
  - SMTP
  - Source Code Manager
  - Token
  - User
  - User Group
  - Variables
- name: Delegate
  tags:
  - Agent mTLS Endpoint Management
  - Delegate Download Resource
  - Delegate Group Tags Resource
  - Delegate Setup Resource
  - Delegate Token Resource
- name: Pipelines
  tags:
  - Pipelines
  - Input Sets
  - Approvals
  - Pipeline Execution
  - Pipeline Dashboard
  - Pipeline Input Set
  - Pipeline
  - Pipeline Execution Details
  - Pipeline Execute
  - Pipeline Refresh
  - Pipeline data retention
  - Triggers
  - TriggersEvents
  - Webhook Triggers
  - Webhook Event Handler
  - DryRunPipeline
- name: Artifact Registry
  tags:
  - Registries
  - Artifacts
  - Docker Artifacts
  - Helm Artifacts
  - quarantine
  - Webhooks
  - Spaces
  - Replication
  - Registry V3 - Registries
  - Registry V3 - Packages
  - Registry V3 - Versions
  - Registry V3 - Files
  - Registry V3 - Metadata
  - Registry V3 - Firewall
  - Registry V3 - Transfer
- name: Database DevOps
  tags:
  - Database Schema
  - Database Instance
  - Deployed State
  - Execution Config
  - Migration State
- name: CD
  tags:
  - K8s Release Service Mapping
  - CustomDeployment
  - Environments
  - EnvironmentGroup
  - Infrastructures
  - Usage
  - File Store
  - Service Dashboard
  - ServiceOverrides
  - Rollback
  - tas
- name: Deployment Freeze
  tags:
  - Freeze CRUD
  - Freeze Evaluation
  - Freeze Schema
- name: Services
  tags:
  - Account Services
  - Org Services
  - Project Services
  - Services
- name: Rancher Infrastructures
  tags:
  - Account Rancher Infrastructure
  - Org Rancher Infrastructure
  - Project Rancher Infrastructure
- name: Templates
  tags:
  - Account Template
  - Org Template
  - Project Template
  - Templates
  - Global Templates
- name: GitOps
  tags:
  - Agents
  - Application
  - Applications
  - Certificates
  - Clusters
  - Dashboard Aggregates
  - Dashboards
  - GnuPGP Keys
  - GPG Keys
  - Hosts
  - Project mappings
  - Projects
  - Reconciler
  - Repositories
  - Repository Certificates
  - Repository credentials
  - ValidateHost
- name: GitX
  tags:
  - GitX Webhooks
  - Org Gitx Webhooks
  - Project Gitx Webhooks
- name: CACM
  tags:
  - Anomalies Ignorelist Rule
  - Anomalies
  - BI Dashboards
  - Budgets
  - Budget Groups
  - Cost Categories
  - Cloud Accounts
  - K8S Connectors Metadata
  - Notification Settings v2
  - Overview
  - Data Job Status
  - Recommendation cost settings
  - Unit Metric
  - Anomaly Comments
  - Cloud and AI cost anomaly details
  - Cloud and AI cost anomalies v2
  - Cost Details
  - Currency Preferences
  - External Data Provider
  - AiEngine
  - CACM governance cost settings
  - Governance Enforcement Recommendation APIs
  - Governance Alert
  - Governance Overview
  - Governance Recommendation APIs
  - RuleEnforcement
  - Rule Executions
  - Rule
  - Rule Sets
  - Perspectives Folders
  - Perspective Reports
  - Perspectives
  - Cost Category Jira Project Mapping
  - Recommendations Details
  - Recommendations
  - Recommendation Jira
  - Recommendation Preferences
  - Recommendation Presets
  - Recommendation Servicenow
  - Recommendation Tags
  - Recommendation Ignore List
  - AutoStopping Rules
  - AutoStopping Rules V2
  - AutoStopping Load Balancers
  - AutoStopping Fixed Schedules
  - AutoStopping Alerts
  - Commitment Orchestrator Events APIs
- name: Feature Flags
  tags:
  - API Keys
  - Feature Flags
  - Targets
  - Target Groups
  - Environment Perspectives
  - Anomalies
  - Proxy
  - Tags
- name: SRM
  tags:
  - Monitored Services
  - SLOs dashboard
  - NG SLOs
  - SLOs
  - Downtime
  - Srm Notification
- name: Internal Developer Portal - IDP
  tags:
  - Entities
  - Teams
  - CatalogCustomProperties
  - Scores
  - DataSource
  - KubernetesDataPoints
  - AggregationRules
  - AppConfig
  - PluginInfo
  - LayoutProxy
  - Kinds
  - LayoutsV3
  - LayoutsV4
- name: Environment Management - IDP
  tags:
  - Environment
  - Infrastructure
  - Instance
- name: Custom Dashboards
  tags:
  - aida
  - dashboards
  - downloads
  - embed
  - folders
- name: Policy Management
  tags:
  - dashboard
  - examples
  - policies
  - evaluate
  - evaluations
  - policysets
  - system
- name: Code
  tags:
  - repository
  - status_checks
  - pullreq
  - upload
  - webhook
  - resource
  - rules
  - labels
- name: IaCM
  tags:
  - usage
  - approvals
  - costs
  - executions
  - module-registry
  - workspaces
  - settings
  - tf-standard-backend
  - variables
- name: STO
  tags:
  - Exemptions
  - Issues
  - Scans
  - Products
  - Test Targets
  - Target Variants
- name: SEI
  tags:
  - Collection categories
  - Collections
  - Contributors
  - DORA
- name: Git Sync (deprecated)
  tags:
  - Git Branches
  - Git Full Sync
  - Git Sync Settings
  - Git Sync
  - Git Sync Errors
- name: Error Models
  tags:
  - Error Response
  - Governance Metadata
- name: Supply Chain Security
  tags:
  - integration
  - PipelineInfraConfig
  - SBOM
  - Integration Step Config
  - Delete Step Config
  - Delete Repositories
  - Pipeline Store Config
  - Evidence Vault [Beta]
- name: Release Management
  tags:
  - Release Groups
  - Releases
  - Orchestration Processes
  - Orchestration Activities
  - Orchestration Executions
  - Conflicts
  - Freeze
  - Reports
  - Uploads
- name: Resilience Testing
  tags:
  - Actions
  - Action Templates
  - Chaos Components
  - Chaos Hubs
  - ChaosGuard Conditions
  - ChaosGuard Rules
  - DR Tests
  - Experiments
  - Experiment Templates
  - Faults
  - Fault Templates
  - Chaos Infrastructure
  - Health
  - Network Maps
  - Onboarding
  - Probes
  - Probe Templates
  - Chaos Recommendations
  - Risks