> ## 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. # Update Cluster Agent Settings Endpoint > Turn the cluster agent's automatic upgrades on or off. With them on (the default) the platform's fleet rollout applies each new agent release as soon as the cluster has no write execution running; with them off the rollout skips this agent until they are turned back on, which is how a team fences a cluster off from agent releases for a freeze window. The bearer twin of the portal's cluster settings switch (ankra cluster agent auto-upgrade enable|disable, MCP set_cluster_agent_auto_upgrade). POST .../agent/upgrade still applies a release on demand whichever way the switch sits. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json patch /api/v1/org/clusters/imported/{cluster_id}/agent/settings 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: AWS Clusters description: >- Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in your own VPC. - 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: 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 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: 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: /api/v1/org/clusters/imported/{cluster_id}/agent/settings: patch: tags: - Imported Clusters summary: Update Cluster Agent Settings Endpoint description: >- Turn the cluster agent's automatic upgrades on or off. With them on (the default) the platform's fleet rollout applies each new agent release as soon as the cluster has no write execution running; with them off the rollout skips this agent until they are turned back on, which is how a team fences a cluster off from agent releases for a freeze window. The bearer twin of the portal's cluster settings switch (ankra cluster agent auto-upgrade enable|disable, MCP set_cluster_agent_auto_upgrade). POST .../agent/upgrade still applies a release on demand whichever way the switch sits. operationId: >- update_cluster_agent_settings_endpoint_api_v1_org_clusters_imported__cluster_id__agent_settings_patch parameters: - in: path name: cluster_id required: true schema: format: uuid4 title: Cluster Id type: string - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-ankra-organisation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Ankra-Organisation-Id requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateClusterAgentSettingsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdateClusterAgentSettingsResult' description: Successful Response '401': description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ContractDetailError' description: Permission or CSRF check failed '404': description: Not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error components: schemas: UpdateClusterAgentSettingsRequest: properties: disable_auto_upgrade: anyOf: - type: boolean - type: 'null' description: >- true fences the agent off from the automatic fleet rollout; false puts it back in. Omitted leaves the setting unchanged. title: Disable Auto Upgrade title: UpdateClusterAgentSettingsRequest type: object UpdateClusterAgentSettingsResult: properties: message: title: Message type: string success: title: Success type: boolean required: - success - message title: UpdateClusterAgentSettingsResult 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 ````