> ## 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. # Get organization security overview (browser session) > Returns the organisation's fleet vulnerability overview: totals and severity counts, fixable severe and CISA known-exploited counts, scanner coverage, the top remediation candidates and the observed trend. Optionally narrowed with `cluster_id` or `addon_slug`; requires `security.read`. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /org/security/overview openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://platform.ankra.app security: [] tags: - 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 and the approval of the authority they declare. - 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: 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: 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: 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: 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. - name: AI Settings description: Organisation AI provider, model catalog and per-function model settings paths: /org/security/overview: get: tags: - Security summary: Get organization security overview (browser session) description: >- Returns the organisation's fleet vulnerability overview: totals and severity counts, fixable severe and CISA known-exploited counts, scanner coverage, the top remediation candidates and the observed trend. Optionally narrowed with `cluster_id` or `addon_slug`; requires `security.read`. operationId: get_security_overview parameters: - in: query name: cluster_id required: false schema: type: string format: uuid - in: query name: addon_slug required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SecurityOverviewResponse' description: Successful response '400': content: application/json: schema: $ref: '#/components/schemas/SecurityDetailError' description: Business validation error '403': content: application/json: schema: $ref: '#/components/schemas/SecurityPermissionDenied' description: Permission or CSRF denied '404': content: application/json: schema: $ref: '#/components/schemas/SecurityDetailError' description: Organization-scoped resource not found '409': content: application/json: schema: $ref: '#/components/schemas/SecurityDetailError' description: Disposition conflict '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: SecurityOverviewResponse: properties: coverage: $ref: '#/components/schemas/SecurityCoverageSummary' fixable_severe: type: integer generated_at: type: string format: date-time observed_trend: items: $ref: '#/components/schemas/SecurityTrendPoint' type: array scanner: $ref: '#/components/schemas/SecurityScannerSummary' severity: $ref: '#/components/schemas/SecuritySeverityCounts' top_remediation_candidates: items: $ref: '#/components/schemas/SecurityRemediationCandidate' type: array totals: $ref: '#/components/schemas/SecurityTotals' known_exploited: type: integer known_exploited_findings: type: integer intelligence: $ref: '#/components/schemas/SecurityIntelligenceStatus' known_exploited_overdue: type: integer known_exploited_ransomware: type: integer required: - totals - severity - fixable_severe - coverage - scanner - top_remediation_candidates - observed_trend - generated_at - known_exploited - known_exploited_findings - intelligence - known_exploited_overdue - known_exploited_ransomware 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 SecurityCoverageSummary: properties: fresh_clusters: type: integer latest_report_at: anyOf: - type: string format: date-time - type: 'null' scanned_clusters: type: integer stale_clusters: type: integer total_clusters: type: integer unscanned_clusters: type: integer required: - total_clusters - scanned_clusters - unscanned_clusters - stale_clusters - fresh_clusters - latest_report_at type: object SecurityTrendPoint: properties: date: format: date type: string observed: type: integer required: - date - observed type: object SecurityScannerSummary: properties: fresh_clusters: type: integer last_scan: anyOf: - type: string format: date-time - type: 'null' stale_after_seconds: type: integer stale_clusters: type: integer status: enum: - fresh - degraded - stale - unscanned type: string unscanned_clusters: type: integer required: - status - last_scan - fresh_clusters - stale_clusters - unscanned_clusters - stale_after_seconds 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 SecurityRemediationCandidate: properties: actionable_count: type: integer affected_clusters: type: integer affected_workloads: type: integer cve_id: type: string finding_id: type: string format: uuid fix_routes: $ref: '#/components/schemas/SecurityFixRoutes' fixable_occurrences: type: integer last_seen_at: type: string format: date-time package_name: type: string package_type: type: string severity: type: string title: anyOf: - type: string - type: 'null' known_exploited: type: boolean kev_date_added: anyOf: - type: string - type: 'null' kev_due_date: anyOf: - type: string - type: 'null' kev_ransomware_use: type: boolean epss_score: anyOf: - format: double type: number - type: 'null' epss_percentile: anyOf: - format: double type: number - type: 'null' kev_vendor_project: anyOf: - type: string - type: 'null' kev_product: anyOf: - type: string - type: 'null' kev_vulnerability_name: anyOf: - type: string - type: 'null' kev_required_action: anyOf: - type: string - type: 'null' required: - finding_id - cve_id - package_type - package_name - severity - title - actionable_count - affected_clusters - affected_workloads - fix_routes - fixable_occurrences - last_seen_at - known_exploited - kev_date_added - kev_due_date - kev_ransomware_use - epss_score - epss_percentile - kev_vendor_project - kev_product - kev_vulnerability_name - kev_required_action 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 SecurityIntelligenceStatus: properties: epss_synced_at: anyOf: - type: string format: date-time - type: 'null' kev_listed: type: integer kev_synced_at: anyOf: - type: string format: date-time - type: 'null' required: - kev_synced_at - epss_synced_at - kev_listed 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 SecurityFixRoutes: description: >- How a finding's actionable occurrences (active, not accepted risk) are cleared. An occurrence with a fixed version and a high-confidence add-on attribution is cleared by upgrading that add-on; one with a fixed version and no such attribution by rebuilding its image; one without a fixed version by neither. The three counts sum to the actionable occurrences and the first two to the fixable ones; route is the summary every surface agrees on. properties: addon_upgrade_occurrences: type: integer addons: items: $ref: '#/components/schemas/SecurityFixRouteAddon' type: array image_rebuild_occurrences: type: integer no_fix_occurrences: type: integer route: enum: - addon_upgrade - image_rebuild - mixed - none type: string required: - route - addon_upgrade_occurrences - image_rebuild_occurrences - no_fix_occurrences - addons type: object SecurityFixRouteAddon: description: >- One add-on whose release upgrade clears part of a finding: the actionable fixable occurrences attributed to it with high confidence, and the clusters they sit on. properties: addon_slug: type: string clusters: type: integer occurrences: type: integer required: - addon_slug - occurrences - clusters type: object ````