> ## 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.

# Export the organisation compliance evidence report



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/security/compliance-report
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - 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.
paths:
  /api/v1/org/security/compliance-report:
    get:
      tags:
        - Security
      summary: Export the organisation compliance evidence report
      operationId: get_security_compliance_report_api_v1
      parameters:
        - description: >-
            Download format; json answers the SecurityComplianceReportResponse
            document, csv answers one sectioned text/csv file whose first column
            names the section (posture, findings, dispositions, audit_summary,
            attestation).
          in: query
          name: format
          required: false
          schema:
            default: json
            enum:
              - json
              - csv
            type: string
        - in: query
          name: start_date
          required: false
          schema:
            format: date-time
            type: string
        - in: query
          name: end_date
          required: false
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityComplianceReportResponse'
            text/csv:
              schema:
                type: string
          description: >-
            The compliance evidence report as a Content-Disposition attachment;
            the audit summary is scoped to the requested start_date/end_date
            window.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDetailError'
          description: Missing, expired or revoked API token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityPermissionDenied'
          description: Missing the security.read or audit.read permission
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDetailError'
          description: Organization-scoped resource not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDetailError'
          description: Internal server error
components:
  schemas:
    SecurityComplianceReportResponse:
      properties:
        attestation:
          $ref: '#/components/schemas/SecurityComplianceAttestation'
        audit_summary:
          $ref: '#/components/schemas/SecurityComplianceAuditSummary'
        compliance:
          $ref: '#/components/schemas/SecurityComplianceOverviewResponse'
        dispositions:
          items:
            $ref: '#/components/schemas/VulnerabilityDispositionPolicy'
          type: array
        findings:
          $ref: '#/components/schemas/SecurityComplianceFindingsSection'
        generated_at:
          format: date-time
          type: string
        organisation_id:
          format: uuid
          type: string
        posture:
          items:
            $ref: '#/components/schemas/SecurityCompliancePostureEntry'
          type: array
        window:
          $ref: '#/components/schemas/SecurityComplianceReportWindow'
      required:
        - organisation_id
        - generated_at
        - window
        - posture
        - findings
        - dispositions
        - audit_summary
        - attestation
        - compliance
      type: object
    SecurityDetailError:
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    SecurityPermissionDenied:
      properties:
        detail:
          enum:
            - permission_denied
          type: string
        permission:
          type: string
        scope_type:
          type: string
      required:
        - detail
        - permission
        - scope_type
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    SecurityComplianceAttestation:
      properties:
        clusters:
          items:
            $ref: '#/components/schemas/SecurityComplianceClusterAttestation'
          type: array
        mfa_required:
          type: boolean
        security_baseline_enabled:
          type: boolean
        sops_initialised:
          type: boolean
      required:
        - mfa_required
        - sops_initialised
        - security_baseline_enabled
        - clusters
      type: object
    SecurityComplianceAuditSummary:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/SecurityComplianceAuditActionCount'
          type: array
        total:
          type: integer
      required:
        - actions
        - total
      type: object
    SecurityComplianceOverviewResponse:
      properties:
        clusters:
          items:
            $ref: '#/components/schemas/SecurityComplianceOverviewCluster'
          type: array
      required:
        - clusters
      type: object
    VulnerabilityDispositionPolicy:
      properties:
        active_match_count:
          type: integer
        created_at:
          format: date-time
          type: string
        created_by:
          type: string
        disposition:
          enum:
            - acknowledged
            - accepted_risk
          type: string
        expire_when_fix_available:
          type: boolean
        expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        fix_available_match_count:
          type: integer
        id:
          format: uuid
          type: string
        last_evaluated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        last_matched_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        match_health:
          type: string
        matched_occurrence_count:
          type: integer
        reason:
          type: string
        revoked_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
        revoked_by:
          anyOf:
            - type: string
            - type: 'null'
        revoked_reason:
          anyOf:
            - type: string
            - type: 'null'
        selector:
          $ref: '#/components/schemas/VulnerabilityDispositionSelector'
        selector_hash:
          type: string
        status:
          type: string
        updated_at:
          format: date-time
          type: string
        updated_by:
          type: string
      required:
        - id
        - selector
        - selector_hash
        - disposition
        - reason
        - expires_at
        - expire_when_fix_available
        - created_by
        - updated_by
        - status
        - match_health
        - matched_occurrence_count
        - active_match_count
        - fix_available_match_count
        - last_evaluated_at
        - last_matched_at
        - revoked_at
        - revoked_by
        - revoked_reason
        - created_at
        - updated_at
      type: object
    SecurityComplianceFindingsSection:
      properties:
        fixable_severe:
          type: integer
        severity:
          $ref: '#/components/schemas/SecuritySeverityCounts'
        totals:
          $ref: '#/components/schemas/SecurityTotals'
      required:
        - totals
        - severity
        - fixable_severe
      type: object
    SecurityCompliancePostureEntry:
      properties:
        accepted_risk_critical:
          type: integer
        accepted_risk_findings:
          type: integer
        accepted_risk_high:
          type: integer
        acknowledged_critical:
          type: integer
        acknowledged_findings:
          type: integer
        acknowledged_high:
          type: integer
        actionable_critical:
          type: integer
        actionable_findings:
          type: integer
        actionable_fixable_critical:
          type: integer
        actionable_fixable_high:
          type: integer
        actionable_high:
          type: integer
        actionable_low:
          type: integer
        actionable_medium:
          type: integer
        actionable_risk_score:
          type: number
        actionable_unknown:
          type: integer
        cluster_id:
          format: uuid
          type: string
        cluster_name:
          type: string
        critical:
          type: integer
        date:
          type: string
        findings:
          type: integer
        fixable_critical:
          type: integer
        fixable_high:
          type: integer
        high:
          type: integer
        low:
          type: integer
        medium:
          type: integer
        namespaces:
          type: integer
        risk_score:
          type: number
        unknown:
          type: integer
        workloads:
          type: integer
      required:
        - cluster_id
        - cluster_name
        - date
        - findings
        - critical
        - high
        - medium
        - low
        - unknown
        - fixable_critical
        - fixable_high
        - workloads
        - namespaces
        - risk_score
        - actionable_findings
        - actionable_critical
        - actionable_high
        - actionable_medium
        - actionable_low
        - actionable_unknown
        - actionable_fixable_critical
        - actionable_fixable_high
        - actionable_risk_score
        - acknowledged_findings
        - acknowledged_critical
        - acknowledged_high
        - accepted_risk_findings
        - accepted_risk_critical
        - accepted_risk_high
      type: object
    SecurityComplianceReportWindow:
      properties:
        end_date:
          format: date-time
          nullable: true
          type: string
        start_date:
          format: date-time
          nullable: true
          type: string
      required:
        - start_date
        - end_date
      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
    SecurityComplianceClusterAttestation:
      properties:
        cluster_id:
          format: uuid
          type: string
        cluster_name:
          type: string
        trivy_operator_installed:
          type: boolean
      required:
        - cluster_id
        - cluster_name
        - trivy_operator_installed
      type: object
    SecurityComplianceAuditActionCount:
      properties:
        action_type:
          type: string
        count:
          type: integer
      required:
        - action_type
        - count
      type: object
    SecurityComplianceOverviewCluster:
      properties:
        benchmarks:
          items:
            $ref: '#/components/schemas/SecurityComplianceBenchmarkTotals'
          type: array
        cluster_id:
          format: uuid
          type: string
        cluster_name:
          type: string
        config_audit:
          allOf:
            - $ref: '#/components/schemas/SecurityComplianceConfigAuditTotals'
          nullable: true
        detail:
          type: string
          nullable: true
        status:
          enum:
            - available
            - not_available
          type: string
      required:
        - cluster_id
        - cluster_name
        - status
        - detail
        - benchmarks
        - config_audit
      type: object
    VulnerabilityDispositionSelector:
      properties:
        addon_slug:
          type: string
        cluster_id:
          format: uuid
          type: string
        cve_id:
          type: string
        explicit_broad:
          type: boolean
        image_digest:
          type: string
        organisation_id:
          format: uuid
          type: string
        package_name:
          type: string
        package_type:
          type: string
        workload_kind:
          type: string
        workload_name:
          type: string
        workload_namespace:
          type: string
      required:
        - organisation_id
      type: object
    SecuritySeverityCounts:
      properties:
        critical:
          type: integer
        high:
          type: integer
        low:
          type: integer
        medium:
          type: integer
        unknown:
          type: integer
      required:
        - critical
        - high
        - medium
        - low
        - unknown
      type: object
    SecurityTotals:
      properties:
        accepted_risk:
          type: integer
        acknowledged:
          type: integer
        actionable:
          type: integer
        observed:
          type: integer
        resolved:
          type: integer
      required:
        - observed
        - actionable
        - acknowledged
        - accepted_risk
        - resolved
      type: object
    SecurityComplianceBenchmarkTotals:
      properties:
        fail_count:
          type: integer
        failed_checks:
          type: integer
        pass_count:
          type: integer
        spec_id:
          type: string
        title:
          type: string
        updated_at:
          type: string
          nullable: true
      required:
        - spec_id
        - title
        - pass_count
        - fail_count
        - failed_checks
        - updated_at
      type: object
    SecurityComplianceConfigAuditTotals:
      properties:
        failed_count:
          type: integer
        report_count:
          type: integer
        severity:
          $ref: '#/components/schemas/SecurityComplianceConfigAuditSeverity'
      required:
        - report_count
        - failed_count
        - severity
      type: object
    SecurityComplianceConfigAuditSeverity:
      properties:
        critical:
          type: integer
        high:
          type: integer
        low:
          type: integer
        medium:
          type: integer
      required:
        - critical
        - high
        - medium
        - low
      type: object

````