Harness App Config API

openapi: 3.2.0
info:
  title: Harness App Config 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: App Config
  description: IDP App Configurations
  x-displayName: IDP App Configurations
paths:
  /v1/plugin-toggle/{plugin-id}:
    parameters:
    - $ref: '#/components/parameters/PluginId'
    post:
      summary: Toggle Plugin
      operationId: toggle-plugin-for-account
      description: Toggle Backstage Plugin
      responses:
        '200':
          $ref: '#/components/responses/AppConfigResponse'
      parameters:
      - schema:
          type: string
        in: header
        name: Harness-Account
        description: Identifier field of the account the resource is scoped to.
      - $ref: '#/components/parameters/PluginName'
      - $ref: '#/components/parameters/Enabled'
      security:
      - x-api-key: []
      tags:
      - App Config
      x-internal: false
  /v1/app-config:
    post:
      summary: Save Or Update Plugin Config
      operationId: save-or-update-plugin-app-config
      description: Save or Update Plugin Config
      responses:
        '200':
          $ref: '#/components/responses/AppConfigResponse'
      security:
      - x-api-key: []
      parameters:
      - $ref: '#/components/parameters/AccountHeader5'
      requestBody:
        $ref: '#/components/requestBodies/AppConfigRequest'
      x-internal: false
      tags:
      - App Config
components:
  schemas:
    AppConfigResponse:
      title: AppConfigResponse
      x-stoplight:
        id: mc5yfk7d3r4ba
      type: object
      properties:
        app_config:
          $ref: '#/components/schemas/AppConfig'
          x-stoplight:
            id: puouuvu1gjvy9
      required:
      - app_config
    ProxyHostDetail:
      title: ProxyHostDetail
      x-stoplight:
        id: agl6s9vai35qw
      type: object
      description: Proxy Host Detail
      properties:
        host:
          type: string
          x-stoplight:
            id: oudzqrxaqnkjy
        proxy:
          type: boolean
          x-stoplight:
            id: 3h03au3y87lyv
        selectors:
          type: array
          x-stoplight:
            id: jdgn49nqlp49k
          items:
            x-stoplight:
              id: zvnhr2daor8lr
            type: string
        identifier:
          type: string
          x-stoplight:
            id: soyi91ysmnt8u
        pluginId:
          type: string
          x-stoplight:
            id: 7we0dzf0ap7v7
      required:
      - host
      - proxy
    BackstageEnvVariable:
      title: BackstageEnvVariable
      x-stoplight:
        id: nxqrkraenk753
      type: object
      description: Backstage Env Variable
      discriminator:
        propertyName: type
        mapping:
          Config: '#/components/schemas/BackstageEnvConfigVariable'
          Secret: '#/components/schemas/BackstageEnvSecretVariable'
      x-examples: {}
      properties:
        identifier:
          type: string
          x-stoplight:
            id: qcqog9dhfhhtn
        env_name:
          type: string
          x-stoplight:
            id: 0br1k8e9y4vds
        created:
          type: integer
          x-stoplight:
            id: jnkz49ajqu2ep
          format: int64
        updated:
          type: integer
          x-stoplight:
            id: f7vn66lecbehz
          format: int64
        type:
          type: string
          x-stoplight:
            id: bkpapdothjik6
          description: This specifies the type of backstage env variable
          enum:
          - Config
          - Secret
      required:
      - env_name
      - type
    AppConfig:
      title: AppConfig
      x-stoplight:
        id: ts8hhn08e9vs2
      type: object
      x-examples: {}
      properties:
        config_id:
          type: string
          x-stoplight:
            id: kba02ulkoob1v
        configs:
          type: string
          x-stoplight:
            id: xu807wjtsvqdt
        enabled:
          type: boolean
          x-stoplight:
            id: ogzhdfovajswl
        enabled_disabled_at:
          type: integer
          x-stoplight:
            id: 8j2nftcvualpg
          format: int64
        created:
          type: integer
          x-stoplight:
            id: i50aktg8l2epd
          format: int64
        updated:
          type: integer
          x-stoplight:
            id: gal7ubavtkx3x
          format: int64
        env_variables:
          type: array
          x-stoplight:
            id: mc8b52k1x79v6
          items:
            $ref: '#/components/schemas/BackstageEnvSecretVariable'
        config_name:
          type: string
          x-stoplight:
            id: 78nnii26gge61
        proxy:
          type: array
          x-stoplight:
            id: 1lk21ekhaopkw
          items:
            $ref: '#/components/schemas/ProxyHostDetail'
      required:
      - config_id
      - configs
      - env_variables
      - config_name
    BackstageEnvSecretVariable:
      title: BackstageEnvSecretVariable
      x-stoplight:
        id: 3h8ht8pko3bgz
      x-discriminator-value: Secret
      allOf:
      - $ref: '#/components/schemas/BackstageEnvVariable'
        x-stoplight:
          id: qv79339cmwg5d
      - type: object
        properties:
          type:
            type: string
            enum:
            - Secret
          harness_secret_identifier:
            type: string
            x-stoplight:
              id: ah15yig0jo9yb
          is_deleted:
            type: boolean
            x-stoplight:
              id: uvmj7ylwufxzc
            default: false
        required:
        - type
        - harness_secret_identifier
      x-examples: {}
    AppConfigRequest:
      title: AppConfigRequest
      x-stoplight:
        id: 8u5xpqsuu97n7
      type: object
      properties:
        app_config:
          $ref: '#/components/schemas/AppConfig'
          x-stoplight:
            id: qrcvsst79yc3s
      required:
      - app_config
  requestBodies:
    AppConfigRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppConfigRequest'
          examples:
            Example 1:
              value:
                app_config:
                  config_id: snyk-security
                  configs: "proxy:\n  '/snyk':\n    target: https://snyk.io/api/v1\n    headers:\n      User-Agent: tech-services/backstage-plugin/1.0\n      Authorization: token ${SNYK_TOKEN}"
                  enabled: true
                  enabled_disabled_at: 0
                  created: 1679589146025
                  updated: 1679589146025
                  env_variables:
                  - env_name: SNYK_TOKEN
                    type: Secret
                    harness_secret_identifier: snyktoken
                  config_name: Snyk Security
  parameters:
    AccountHeader5:
      name: Harness-Account
      in: header
      required: false
      schema:
        type: string
      description: Identifier field of the account the resource is scoped to.
    Enabled:
      name: enabled
      in: query
      required: true
      schema:
        type: boolean
      description: flag for checking enablement/disablement
    PluginName:
      name: plugin_name
      in: query
      required: false
      schema:
        type: string
        default: null
      description: 'Plugin name for filtering '
    PluginId:
      name: plugin-id
      in: path
      description: Plugin Identifier
      required: true
      schema:
        type: string
  responses:
    AppConfigResponse:
      description: Example response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AppConfigResponse'
        application/xml:
          schema:
            type: object
            properties: {}
        multipart/form-data:
          schema:
            type: object
            properties: {}
        text/html:
          schema:
            type: object
            properties: {}
  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