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

# Create Sync Operation

> Accept a preview and return before any Git or resource work begins.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json post /workspaces/{workspace_id}/workflows/sync/operations
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/workflows/sync/operations:
    post:
      tags:
        - workflows
      summary: Create Sync Operation
      description: Accept a preview and return before any Git or resource work begins.
      operationId: workflows-create_sync_operation
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncOperationCreate-Input'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncOperationRead'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncOperationError'
          description: Bad Request
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ScopeDeniedResponse'
                  - $ref: '#/components/schemas/SyncOperationError'
                title: Response 403 Workflows-Create Sync Operation
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncOperationError'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncOperationError'
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncOperationError'
          description: Service Unavailable
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    SyncOperationCreate-Input:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        direction:
          $ref: '#/components/schemas/SyncDirection'
        push:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceSyncExportRequest-Input'
            - type: 'null'
        pull:
          anyOf:
            - $ref: '#/components/schemas/WorkflowSyncPullRequest'
            - type: 'null'
        compare_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Compare Ref
      additionalProperties: false
      type: object
      required:
        - id
        - direction
      title: SyncOperationCreate
      description: Start a preview; reuse the client-generated ID after a lost response.
    SyncOperationRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        direction:
          $ref: '#/components/schemas/SyncDirection'
        status:
          $ref: '#/components/schemas/SyncStatus'
        stage:
          $ref: '#/components/schemas/SyncStage'
        created_at:
          type: string
          format: date-time
          title: Created At
        expires_at:
          type: string
          format: date-time
          title: Expires At
        commit_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit Sha
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        preview:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceSyncExportPreview'
            - $ref: '#/components/schemas/PullResult'
            - type: 'null'
          title: Preview
        result:
          anyOf:
            - $ref: '#/components/schemas/SyncPushResult'
            - $ref: '#/components/schemas/PullResult'
            - type: 'null'
          title: Result
        diff_count:
          type: integer
          title: Diff Count
          default: 0
        can_retry:
          type: boolean
          title: Can Retry
          default: false
        data_applied:
          type: boolean
          title: Data Applied
          default: false
        inputs:
          $ref: '#/components/schemas/SyncOperationCreate-Output'
        preview_revision:
          type: integer
          title: Preview Revision
          default: 0
        state_revision:
          type: integer
          title: State Revision
          default: 0
      type: object
      required:
        - id
        - direction
        - status
        - stage
        - created_at
        - expires_at
        - inputs
      title: SyncOperationRead
      description: Small polling response, independent of the number of synced files.
    SyncOperationError:
      properties:
        detail:
          type: string
          title: Detail
      type: object
      required:
        - detail
      title: SyncOperationError
      description: Expected operation conflict and diff lookup failures.
    ScopeDeniedResponse:
      properties:
        error:
          $ref: '#/components/schemas/ScopeDeniedErrorDetail'
      type: object
      required:
        - error
      title: ScopeDeniedResponse
      description: HTTP 403 response emitted by the scope-denial exception handler.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SyncDirection:
      type: string
      enum:
        - push
        - pull
    WorkspaceSyncExportRequest-Input:
      properties:
        message:
          type: string
          minLength: 1
          title: Message
          description: Commit message for the export.
        branch:
          type: string
          title: Branch
          description: Target branch to commit to.
        create_pr:
          type: boolean
          title: Create Pr
          description: Whether to open a pull request for the commit.
          default: false
        pr_base_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Pr Base Branch
          description: Base branch for the pull request, if created.
        resources:
          anyOf:
            - items:
                $ref: '#/components/schemas/ResourceRef'
              type: array
            - type: 'null'
          title: Resources
          description: Specific resources to export, or ``None`` to export all.
        include_schedules:
          type: boolean
          title: Include Schedules
          description: Whether to include workflow schedules in the export.
          default: false
      type: object
      required:
        - message
        - branch
      title: WorkspaceSyncExportRequest
      description: Request to commit selected workspace resources to a Git branch.
    WorkflowSyncPullRequest:
      properties:
        commit_sha:
          type: string
          maxLength: 64
          minLength: 40
          title: Commit Sha
          description: Specific commit SHA to pull from
        dry_run:
          type: boolean
          title: Dry Run
          description: Validate only, don't perform actual import
          default: false
        sync_schedules:
          type: boolean
          title: Sync Schedules
          description: >-
            Apply schedule definitions from Git. Defaults off to preserve
            destination schedules.
          default: false
        catalog_mappings:
          items:
            $ref: '#/components/schemas/CatalogMappingSelection'
          type: array
          title: Catalog Mappings
          description: Explicit source-to-target model choices from the pull preview.
        mcp_integration_mappings:
          items:
            $ref: '#/components/schemas/McpIntegrationMappingSelection'
          type: array
          title: Mcp Integration Mappings
          description: >-
            Explicit source-to-target MCP integration choices from the pull
            preview.
        secret_store_mappings:
          items:
            $ref: '#/components/schemas/SecretStoreMappingSelection'
          type: array
          title: Secret Store Mappings
          description: Target stores for AWS-backed secrets whose store name has no match.
      type: object
      required:
        - commit_sha
      title: WorkflowSyncPullRequest
      description: Request model for pulling workflows from a Git repository.
    SyncStatus:
      type: string
      enum:
        - queued
        - running
        - ready
        - applying
        - completed
        - failed
        - expired
    SyncStage:
      type: string
      enum:
        - fetching
        - preparing
        - awaiting_confirmation
        - applying
        - finishing
        - finished
    WorkspaceSyncExportPreview:
      properties:
        resource_counts:
          additionalProperties:
            type: integer
          type: object
          title: Resource Counts
          description: Count of resources to commit, keyed by resource type.
        files:
          items:
            type: string
          type: array
          title: Files
          description: Repository-relative paths the export would write.
        resources:
          items:
            $ref: '#/components/schemas/WorkspaceSyncPreviewResource'
          type: array
          title: Resources
          description: Displayable resources included in the export preview.
        resource_diffs:
          items:
            $ref: '#/components/schemas/PullResourceDiff'
          type: array
          title: Resource Diffs
          description: >-
            Per-resource file diffs between the comparison ref and projected
            export.
      type: object
      required:
        - resource_counts
        - files
      title: WorkspaceSyncExportPreview
      description: |-
        Projection summary of the resources an export would commit.

        Mirrors the pull dry-run preview: it projects the selected resources
        locally without writing to Git or mutating sync mappings.
    PullResult:
      properties:
        success:
          type: boolean
          title: Success
        commit_sha:
          type: string
          title: Commit Sha
        workflows_found:
          type: integer
          title: Workflows Found
        workflows_imported:
          type: integer
          title: Workflows Imported
        diagnostics:
          items:
            $ref: '#/components/schemas/PullDiagnostic'
          type: array
          title: Diagnostics
        message:
          type: string
          title: Message
        resource_counts:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/ResourcePullCount'
              type: object
            - type: 'null'
          title: Resource Counts
        resource_diffs:
          anyOf:
            - items:
                $ref: '#/components/schemas/PullResourceDiff'
              type: array
            - type: 'null'
          title: Resource Diffs
        files:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Files
        resources:
          anyOf:
            - items:
                $ref: '#/components/schemas/SyncPreviewResource'
              type: array
            - type: 'null'
          title: Resources
        library_skill_installs:
          items:
            type: string
          type: array
          title: Library Skill Installs
        catalog_mapping_requirements:
          anyOf:
            - items:
                $ref: '#/components/schemas/CatalogMappingRequirement'
              type: array
            - type: 'null'
          title: Catalog Mapping Requirements
        mcp_integration_mapping_requirements:
          anyOf:
            - items:
                $ref: '#/components/schemas/McpIntegrationMappingRequirement'
              type: array
            - type: 'null'
          title: Mcp Integration Mapping Requirements
        secret_store_mapping_requirements:
          anyOf:
            - items:
                $ref: '#/components/schemas/SecretStoreMappingRequirement'
              type: array
            - type: 'null'
          title: Secret Store Mapping Requirements
      type: object
      required:
        - success
        - commit_sha
        - workflows_found
        - workflows_imported
        - diagnostics
        - message
      title: PullResult
    SyncPushResult:
      properties:
        commit:
          $ref: '#/components/schemas/CommitInfo'
      type: object
      required:
        - commit
      title: SyncPushResult
      description: Compact durable push receipt; file details stay in paginated artifacts.
    SyncOperationCreate-Output:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        direction:
          $ref: '#/components/schemas/SyncDirection'
        push:
          anyOf:
            - $ref: '#/components/schemas/WorkspaceSyncExportRequest-Output'
            - type: 'null'
        pull:
          anyOf:
            - $ref: '#/components/schemas/WorkflowSyncPullRequest'
            - type: 'null'
        compare_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Compare Ref
      additionalProperties: false
      type: object
      required:
        - id
        - direction
      title: SyncOperationCreate
      description: Start a preview; reuse the client-generated ID after a lost response.
    ScopeDeniedErrorDetail:
      properties:
        code:
          type: string
          const: insufficient_scope
          title: Code
        message:
          type: string
          title: Message
        required_scopes:
          items:
            type: string
          type: array
          title: Required Scopes
        missing_scopes:
          items:
            type: string
          type: array
          title: Missing Scopes
      type: object
      required:
        - code
        - message
        - required_scopes
        - missing_scopes
      title: ScopeDeniedErrorDetail
      description: Structured explanation of an authorization scope denial.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ResourceRef:
      properties:
        resource_type:
          $ref: '#/components/schemas/SyncResourceType'
          description: Type of the referenced resource.
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
          description: Git source id of the resource, if referenced by source id.
        local_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Local Id
          description: Local database id of the resource, if referenced by local id.
      type: object
      required:
        - resource_type
      title: ResourceRef
      description: Reference to a single resource by type and either source or local id.
    CatalogMappingSelection:
      properties:
        source_catalog_id:
          type: string
          format: uuid
          title: Source Catalog Id
        target_catalog_id:
          type: string
          format: uuid
          title: Target Catalog Id
      type: object
      required:
        - source_catalog_id
        - target_catalog_id
      title: CatalogMappingSelection
      description: User-selected target catalog row for one source catalog reference.
    McpIntegrationMappingSelection:
      properties:
        source_mcp_integration_id:
          type: string
          format: uuid
          title: Source Mcp Integration Id
        target_mcp_integration_id:
          type: string
          format: uuid
          title: Target Mcp Integration Id
      type: object
      required:
        - source_mcp_integration_id
        - target_mcp_integration_id
      title: McpIntegrationMappingSelection
      description: >-
        User-selected local MCP integration for one source integration
        reference.
    SecretStoreMappingSelection:
      properties:
        source_store:
          type: string
          minLength: 1
          title: Source Store
        target_store_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Target Store Id
      type: object
      required:
        - source_store
        - target_store_id
      title: SecretStoreMappingSelection
      description: >-
        User-selected store for one store name; null leaves its secrets
        unlinked.
    WorkspaceSyncPreviewResource:
      properties:
        resource_type:
          $ref: '#/components/schemas/SyncResourceType'
          description: Type of resource included in the preview.
        source_id:
          type: string
          title: Source Id
          description: Stable Git source id for the resource.
        name:
          type: string
          title: Name
          description: Human-readable resource name.
        path:
          type: string
          title: Path
          description: Primary repository path written for the resource.
      type: object
      required:
        - resource_type
        - source_id
        - name
        - path
      title: WorkspaceSyncPreviewResource
      description: One resource included in a workspace sync export preview.
    PullResourceDiff:
      properties:
        resource_type:
          type: string
          title: Resource Type
        source_id:
          type: string
          title: Source Id
        source_path:
          type: string
          title: Source Path
        change_type:
          type: string
          enum:
            - added
            - modified
            - deleted
          title: Change Type
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        diff:
          type: string
          title: Diff
        truncated:
          type: boolean
          title: Truncated
          default: false
      type: object
      required:
        - resource_type
        - source_id
        - source_path
        - change_type
        - title
        - diff
      title: PullResourceDiff
    PullDiagnostic:
      properties:
        workflow_path:
          type: string
          title: Workflow Path
        workflow_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Title
        error_type:
          type: string
          enum:
            - conflict
            - validation
            - dependency
            - parse
            - github
            - system
            - transaction
          title: Error Type
        message:
          type: string
          title: Message
        details:
          additionalProperties: true
          type: object
          title: Details
      type: object
      required:
        - workflow_path
        - workflow_title
        - error_type
        - message
        - details
      title: PullDiagnostic
    ResourcePullCount:
      properties:
        found:
          type: integer
          title: Found
        imported:
          type: integer
          title: Imported
      type: object
      required:
        - found
        - imported
      title: ResourcePullCount
    SyncPreviewResource:
      properties:
        resource_type:
          type: string
          title: Resource Type
        source_id:
          type: string
          title: Source Id
        name:
          type: string
          title: Name
        path:
          type: string
          title: Path
      type: object
      required:
        - resource_type
        - source_id
        - name
        - path
      title: SyncPreviewResource
    CatalogMappingRequirement:
      properties:
        source_catalog_id:
          type: string
          format: uuid
          title: Source Catalog Id
        model_provider:
          type: string
          title: Model Provider
        model_name:
          type: string
          title: Model Name
        reason:
          $ref: '#/components/schemas/CatalogMappingRequirementReason'
        message:
          type: string
          title: Message
        candidates:
          items:
            $ref: '#/components/schemas/CatalogMappingCandidate'
          type: array
          title: Candidates
        affected_presets:
          items:
            $ref: '#/components/schemas/CatalogMappingAffectedPreset'
          type: array
          title: Affected Presets
        affected_workflows:
          items:
            $ref: '#/components/schemas/CatalogMappingAffectedWorkflow'
          type: array
          title: Affected Workflows
      type: object
      required:
        - source_catalog_id
        - model_provider
        - model_name
        - reason
        - message
        - candidates
        - affected_presets
        - affected_workflows
      title: CatalogMappingRequirement
    McpIntegrationMappingRequirement:
      properties:
        source_mcp_integration_id:
          type: string
          format: uuid
          title: Source Mcp Integration Id
        slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Slug
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        server_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Server Type
        auth_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Auth Type
        reason:
          $ref: '#/components/schemas/McpIntegrationMappingRequirementReason'
        message:
          type: string
          title: Message
        candidates:
          items:
            $ref: '#/components/schemas/McpIntegrationMappingCandidate'
          type: array
          title: Candidates
        affected_presets:
          items:
            $ref: '#/components/schemas/McpIntegrationMappingAffectedPreset'
          type: array
          title: Affected Presets
        affected_workflows:
          items:
            $ref: '#/components/schemas/McpIntegrationMappingAffectedWorkflow'
          type: array
          title: Affected Workflows
      type: object
      required:
        - source_mcp_integration_id
        - slug
        - name
        - server_type
        - auth_type
        - reason
        - message
        - candidates
        - affected_presets
        - affected_workflows
      title: McpIntegrationMappingRequirement
    SecretStoreMappingRequirement:
      properties:
        source_store:
          type: string
          title: Source Store
        reason:
          $ref: '#/components/schemas/SecretStoreMappingRequirementReason'
        message:
          type: string
          title: Message
        candidates:
          items:
            $ref: '#/components/schemas/SecretStoreMappingCandidate'
          type: array
          title: Candidates
        affected_secrets:
          items:
            $ref: '#/components/schemas/SecretStoreMappingAffectedSecret'
          type: array
          title: Affected Secrets
      type: object
      required:
        - source_store
        - reason
        - message
        - candidates
        - affected_secrets
      title: SecretStoreMappingRequirement
    CommitInfo:
      properties:
        status:
          $ref: '#/components/schemas/PushStatus'
        sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Sha
        ref:
          type: string
          title: Ref
        base_ref:
          type: string
          title: Base Ref
        pr_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Pr Url
        pr_number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Pr Number
        pr_reused:
          type: boolean
          title: Pr Reused
          default: false
        message:
          type: string
          title: Message
          default: ''
      type: object
      required:
        - status
        - sha
        - ref
        - base_ref
      title: CommitInfo
    WorkspaceSyncExportRequest-Output:
      properties:
        message:
          type: string
          minLength: 1
          title: Message
          description: Commit message for the export.
        branch:
          type: string
          title: Branch
          description: Target branch to commit to.
        create_pr:
          type: boolean
          title: Create Pr
          description: Whether to open a pull request for the commit.
          default: false
        pr_base_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Pr Base Branch
          description: Base branch for the pull request, if created.
        resources:
          anyOf:
            - items:
                $ref: '#/components/schemas/ResourceRef'
              type: array
            - type: 'null'
          title: Resources
          description: Specific resources to export, or ``None`` to export all.
        include_schedules:
          type: boolean
          title: Include Schedules
          description: Whether to include workflow schedules in the export.
          default: false
      type: object
      required:
        - message
        - branch
      title: WorkspaceSyncExportRequest
      description: Request to commit selected workspace resources to a Git branch.
    SyncResourceType:
      type: string
      enum:
        - workflow
        - agent_preset
        - skill
        - table
        - case_tag
        - case_field
        - case_dropdown
        - case_duration
        - variable
        - secret_metadata
      title: SyncResourceType
      description: |-
        Kind of workspace resource that can be synced to and from Git.

        Every member is adapter-backed: it can be projected to and imported from
        repository files.
    CatalogMappingRequirementReason:
      type: string
      enum:
        - ambiguous
        - invalid_selection
    CatalogMappingCandidate:
      properties:
        catalog_id:
          type: string
          format: uuid
          title: Catalog Id
        model_provider:
          type: string
          title: Model Provider
        model_name:
          type: string
          title: Model Name
        provider_name:
          type: string
          title: Provider Name
        model_display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Model Display Name
        endpoint_hostname:
          anyOf:
            - type: string
            - type: 'null'
          title: Endpoint Hostname
        origin:
          type: string
          enum:
            - platform
            - organization
            - custom_provider
          title: Origin
      type: object
      required:
        - catalog_id
        - model_provider
        - model_name
        - provider_name
        - model_display_name
        - endpoint_hostname
        - origin
      title: CatalogMappingCandidate
    CatalogMappingAffectedPreset:
      properties:
        preset_slug:
          type: string
          title: Preset Slug
        preset_name:
          type: string
          title: Preset Name
        version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version
        path:
          type: string
          title: Path
      type: object
      required:
        - preset_slug
        - preset_name
        - version
        - path
      title: CatalogMappingAffectedPreset
    CatalogMappingAffectedWorkflow:
      properties:
        workflow_source_id:
          type: string
          title: Workflow Source Id
        workflow_path:
          type: string
          title: Workflow Path
        workflow_title:
          type: string
          title: Workflow Title
        action_ref:
          type: string
          title: Action Ref
      type: object
      required:
        - workflow_source_id
        - workflow_path
        - workflow_title
        - action_ref
      title: CatalogMappingAffectedWorkflow
    McpIntegrationMappingRequirementReason:
      type: string
      enum:
        - unresolved
        - invalid_selection
        - conflicting_metadata
    McpIntegrationMappingCandidate:
      properties:
        mcp_integration_id:
          type: string
          format: uuid
          title: Mcp Integration Id
        slug:
          type: string
          title: Slug
        name:
          type: string
          title: Name
        server_type:
          type: string
          title: Server Type
        auth_type:
          type: string
          title: Auth Type
      type: object
      required:
        - mcp_integration_id
        - slug
        - name
        - server_type
        - auth_type
      title: McpIntegrationMappingCandidate
    McpIntegrationMappingAffectedPreset:
      properties:
        preset_slug:
          type: string
          title: Preset Slug
        preset_name:
          type: string
          title: Preset Name
        version:
          anyOf:
            - type: integer
            - type: 'null'
          title: Version
        path:
          type: string
          title: Path
      type: object
      required:
        - preset_slug
        - preset_name
        - version
        - path
      title: McpIntegrationMappingAffectedPreset
    McpIntegrationMappingAffectedWorkflow:
      properties:
        workflow_source_id:
          type: string
          title: Workflow Source Id
        workflow_path:
          type: string
          title: Workflow Path
        workflow_title:
          type: string
          title: Workflow Title
        action_ref:
          type: string
          title: Action Ref
      type: object
      required:
        - workflow_source_id
        - workflow_path
        - workflow_title
        - action_ref
      title: McpIntegrationMappingAffectedWorkflow
    SecretStoreMappingRequirementReason:
      type: string
      enum:
        - unresolved
        - invalid_selection
    SecretStoreMappingCandidate:
      properties:
        store_id:
          type: string
          format: uuid
          title: Store Id
        name:
          type: string
          title: Name
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
      type: object
      required:
        - store_id
        - name
        - region
      title: SecretStoreMappingCandidate
    SecretStoreMappingAffectedSecret:
      properties:
        secret_name:
          type: string
          title: Secret Name
        environment:
          type: string
          title: Environment
        path:
          type: string
          title: Path
      type: object
      required:
        - secret_name
        - environment
        - path
      title: SecretStoreMappingAffectedSecret
    PushStatus:
      type: string
      enum:
        - committed
        - no_op
      title: PushStatus
      description: Status of a push/commit operation.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````

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