> ## 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. # Set hosted log shipping > Turns hosted log shipping on or off for this cluster (`ankra cluster logs-ship enable|disable`). While it is on and the hosted store is live, the cluster's agent sends the log lines of every running container to Ankra's hosted log store, where members of the organisation can search them; turning it off stops shipping within about a minute. Lines already stored age out with the store's retention. Every change is recorded in the organisation's audit log; re-sending the current value changes nothing. Requires `clusters.write` on the cluster. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json put /api/v1/org/clusters/{cluster_id}/hosted-logs 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, the approval of the authority they declare, and the caches pipelines keep between runs. - 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: 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: 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: 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}/hosted-logs: put: tags: - Clusters summary: Set hosted log shipping description: >- Turns hosted log shipping on or off for this cluster (`ankra cluster logs-ship enable|disable`). While it is on and the hosted store is live, the cluster's agent sends the log lines of every running container to Ankra's hosted log store, where members of the organisation can search them; turning it off stops shipping within about a minute. Lines already stored age out with the store's retention. Every change is recorded in the organisation's audit log; re-sending the current value changes nothing. Requires `clusters.write` on the cluster. operationId: set_hosted_logs_api_v1_org_clusters__cluster_id__hosted_logs_put 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/HostedLogShippingRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/HostedLogShippingView' 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: >- Permission check failed (`clusters.write`), or the token may not use this surface '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: `shipping_enabled` is missing or not a boolean '500': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Internal server error security: - BearerAuth: [] components: schemas: HostedLogShippingRequest: additionalProperties: false description: Turns a cluster's hosted log shipping on or off. properties: shipping_enabled: description: >- True sends the cluster's container log lines to Ankra's hosted log store; false stops it. Must be a JSON boolean. type: boolean required: - shipping_enabled type: object HostedLogShippingView: description: A cluster's hosted log shipping switch. example: agent_supports_switch: true available: true changed_at: '2026-10-05T20:00:00Z' cluster_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 shipping_enabled: true properties: cluster_id: type: string format: uuid shipping_enabled: description: The stored switch. Off for every cluster until a member turns it on. type: boolean available: description: >- Ankra's hosted log store is live on this platform. While false the switch can be stored, but nothing ships and nothing is read. type: boolean agent_supports_switch: description: >- The cluster's agent advertised that it obeys the switch. False means no agent can ship yet: the agent needs an upgrade, or hosted log shipping is turned off in its own Helm values. type: boolean changed_at: anyOf: - type: string format: date-time - type: 'null' description: When the switch last changed; null when nobody has changed it. required: - cluster_id - shipping_enabled - available - agent_supports_switch - changed_at 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 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.