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

# Replace a cluster power schedule

> The bearer twin of the portal's power-schedule update (`ankra cluster power-schedules update`). A full replace, not a patch: `enabled` must always be sent, `stop_mode` must be restated for a stop schedule, and `timezone` for a cron schedule. The response is the cluster's refreshed schedule listing.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /api/v1/org/clusters/imported/{cluster_id}/power-schedules/{schedule_id}
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: 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: 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}/power-schedules/{schedule_id}:
    put:
      tags:
        - Imported Clusters
      summary: Replace a cluster power schedule
      description: >-
        The bearer twin of the portal's power-schedule update (`ankra cluster
        power-schedules update`). A full replace, not a patch: `enabled` must
        always be sent, `stop_mode` must be restated for a stop schedule, and
        `timezone` for a cron schedule. The response is the cluster's refreshed
        schedule listing.
      operationId: update_imported_cluster_power_schedule_api_v1
      parameters:
        - name: cluster_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: schedule_id
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PowerScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PowerScheduleListResponse'
          description: The cluster's schedule listing after the update.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Missing, expired or revoked API token
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityPermissionDenied'
          description: >-
            Missing the clusters.write permission on this cluster, or a scoped
            token without it
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Cluster or power schedule not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: >-
            Refused by the cluster: scheduled stop and start are only available
            for provider-managed clusters; a pause stop is not supported on this
            provider and distribution; the cluster already has the maximum of 20
            power schedules; or an enabled scale_to_zero stop on a cluster with
            node-local claims was sent without accept_node_local_data_loss true
            (the detail names the claims)
        '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
components:
  schemas:
    PowerScheduleRequest:
      description: >-
        The shared create/update body. Exactly one of run_at (schedule_kind
        once) or cron_expression (schedule_kind cron) applies. Updates are full
        replaces: enabled must be sent, stop_mode must be restated for a stop
        schedule, and timezone for a cron schedule.
      properties:
        action:
          enum:
            - stop
            - start
          type: string
        stop_mode:
          default: delete_resources
          description: >-
            Stop schedules only: delete_resources (the full teardown),
            scale_to_zero (park only the workers) or pause (power off and keep
            the servers; k3s on Hetzner, UpCloud and DigitalOcean, and AWS and
            Scaleway).
          enum:
            - delete_resources
            - scale_to_zero
            - pause
          type: string
        preserve_state:
          default: true
          description: >-
            A delete_resources stop captures the cluster's state first on the
            providers that support it.
          type: boolean
        schedule_kind:
          enum:
            - once
            - cron
          type: string
        run_at:
          description: RFC 3339 timestamp in the future; required for schedule_kind once.
          format: date-time
          type: string
        cron_expression:
          description: >-
            Standard 5-field cron expression (or an @-descriptor) without an
            embedded timezone; required for schedule_kind cron.
          type: string
        timezone:
          default: UTC
          description: IANA timezone name.
          type: string
        enabled:
          default: true
          description: Required on update.
          type: boolean
        accept_node_local_data_loss:
          default: false
          description: >-
            The caller's written acceptance that an enabled scale_to_zero stop
            deletes the data persistent volume claims keep on a worker's own
            disk, at every stop. Required for such a stop on a cluster whose
            inventory shows node-local claims (GET
            .../power-schedules/node-local-storage answers consent_required);
            without it the write is refused with 409 naming the claims. Never
            implied.
          type: boolean
      required:
        - action
        - schedule_kind
      type: object
    PowerScheduleListResponse:
      properties:
        schedules:
          items:
            $ref: '#/components/schemas/PowerSchedule'
          type: array
      required:
        - schedules
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      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
    PowerSchedule:
      description: One scheduled stop/start entry on a cluster.
      properties:
        id:
          type: string
          format: uuid
        action:
          enum:
            - stop
            - start
          type: string
        stop_mode:
          description: >-
            How a stop stops the cluster; start schedules always carry
            delete_resources.
          enum:
            - delete_resources
            - scale_to_zero
            - pause
          type: string
        preserve_state:
          type: boolean
        schedule_kind:
          enum:
            - once
            - cron
          type: string
        run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        cron_expression:
          anyOf:
            - type: string
            - type: 'null'
        timezone:
          description: IANA timezone the cron expression is evaluated in.
          type: string
        enabled:
          type: boolean
        next_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        last_run_status:
          anyOf:
            - type: string
            - type: 'null'
        last_run_detail:
          anyOf:
            - type: string
            - type: 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - action
        - stop_mode
        - preserve_state
        - schedule_kind
        - run_at
        - cron_expression
        - timezone
        - enabled
        - next_run_at
        - last_run_at
        - last_run_status
        - last_run_detail
        - created_at
        - updated_at
      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

````