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

# List preserved GitOps paths

> Lists the files Git and the platform are divided on: each was edited in Git, so Ankra keeps Git's bytes there instead of overwriting them, and the platform's later changes to it do not reach Git. Every entry carries both sides - withheld, with the reason, for a file that may carry a secret - and any decision already recorded, in path order and capped at 100 entries and a content budget (truncated says when either cap applied). Unlike a GitOps merge conflict a preserved file pauses nothing. Bearer-PAT twin of the browser route of the same name under /org.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/clusters/{cluster_id}/gitops/preserved-paths
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/clusters/{cluster_id}/gitops/preserved-paths:
    get:
      tags:
        - Clusters
      summary: List preserved GitOps paths
      description: >-
        Lists the files Git and the platform are divided on: each was edited in
        Git, so Ankra keeps Git's bytes there instead of overwriting them, and
        the platform's later changes to it do not reach Git. Every entry carries
        both sides - withheld, with the reason, for a file that may carry a
        secret - and any decision already recorded, in path order and capped at
        100 entries and a content budget (truncated says when either cap
        applied). Unlike a GitOps merge conflict a preserved file pauses
        nothing. Bearer-PAT twin of the browser route of the same name under
        /org.
      operationId: >-
        list_gitops_preserved_paths_api_v1_org_clusters__cluster_id__gitops_preserved_paths_get
      parameters:
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
        - name: cluster_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GitOpsPreservedPathListResponse'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Missing or malformed Authorization header
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unknown, expired, or revoked API token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Token may not use this surface (MCP-scoped token or service account
            restriction)
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Cluster not found in the token's organisation
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Internal server error
      security:
        - BearerAuth: []
components:
  schemas:
    GitOpsPreservedPathListResponse:
      properties:
        preserved_paths:
          description: The preserved files in path order, at most 100.
          items:
            $ref: '#/components/schemas/GitOpsPreservedPath'
          title: Preserved Paths
          type: array
        total:
          description: >-
            The number of preserved files on the cluster, including any past the
            listing's cap.
          title: Total
          type: integer
        truncated:
          default: false
          description: >-
            True when the listing left something out: files past the 100-entry
            cap (total says how many), or content past the listing's content
            budget (those entries carry content_omitted).
          title: Truncated
          type: boolean
      required:
        - preserved_paths
        - total
      title: GitOpsPreservedPathListResponse
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    GitOpsPreservedPath:
      description: >-
        A file in Git the platform did not write, which Ankra keeps instead of
        overwriting with its own version, so Git and the platform are divided on
        it.
      properties:
        path:
          description: Full repository path of the file.
          title: Path
          type: string
        head_content:
          description: >-
            The file as Git holds it at head_commit_sha. Empty when
            content_redacted or content_omitted is true.
          title: Head Content
          type: string
        head_content_hash:
          description: >-
            Digest of the file as Git holds it, exact even when the content is
            withheld. A resolve must name it with render_content_hash, so a
            decision only ever applies to the two sides it was made over.
          title: Head Content Hash
          type: string
        render_content:
          description: >-
            What the platform would write to the file. Empty when
            content_redacted or content_omitted is true.
          title: Render Content
          type: string
        render_content_hash:
          description: >-
            Digest of what the platform would write, exact even when the content
            is withheld. A resolve must name it with head_content_hash.
          title: Render Content Hash
          type: string
        content_redacted:
          default: false
          description: >-
            True when neither side is stored or served because the file may
            carry a secret: SOPS-encrypted content, a Kubernetes Secret, a
            credential-shaped value, a path a .sops.yaml creation rule covers,
            or content that could not be parsed well enough to tell. The digests
            are still exact, so the file can be decided from Git directly.
          title: Content Redacted
          type: boolean
        content_redacted_reason:
          anyOf:
            - enum:
                - sops_encrypted
                - sops_creation_rule
                - unverifiable
                - secret
                - sensitive_value
              type: string
            - type: 'null'
          title: Content Redacted Reason
          description: >-
            Why the content is withheld, or null when it is not. A cluster
            decision is refused on sops_encrypted content, because it would
            replace ciphertext in Git with plaintext.
        content_omitted:
          default: false
          description: >-
            True when this entry is past the listing's content budget: it is
            complete except for the two content fields. The listing's truncated
            flag is set with it.
          title: Content Omitted
          type: boolean
        head_commit_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Head Commit Sha
          description: The commit the head content was read at.
        detected_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Detected At
          description: When the current head content was first found preserved.
        last_seen_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Seen At
          description: >-
            When a push last found the file still preserved, refreshed at most
            hourly.
        resolution_choice:
          anyOf:
            - enum:
                - git
                - cluster
              type: string
            - type: 'null'
          title: Resolution Choice
          description: >-
            null while the file awaits a decision; git once a person chose to
            import Git's content, cluster once they chose to write Ankra's
            version into Git. Cleared when either side changes, when a git
            import is refused, or when the decision is withdrawn.
        resolved_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Resolved At
          description: >-
            When the current decision was first recorded; repeating the same
            decision keeps it. null while the file awaits a decision.
        import_refused_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Import Refused Reason
          description: >-
            Why the last git decision over these two sides was not imported -
            for example, Git's version would lower an add-on's chart version -
            after which the decision was cleared so a person decides again.
            Cleared when either side changes.
        import_refused_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Import Refused At
          description: When the import named by import_refused_reason was refused.
      required:
        - path
        - head_content
        - head_content_hash
        - render_content
        - render_content_hash
      title: GitOpsPreservedPath
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

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