Cast AI Hibernation Schedules API

openapi: 3.2.0
info:
  title: Cluster Autoscaler Hibernation Schedules API
  version: 0.0.1
  description: HibernationSchedulesAPI handles interaction with organization hibernation schedules
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: HibernationSchedulesAPI
  description: HibernationSchedulesAPI handles interaction with organization hibernation schedules
paths:
  /cluster-autoscaler/v1beta/organizations/{organizationId}/hibernation-schedules:
    post:
      tags:
      - HibernationSchedulesAPI
      summary: Create a hibernation schedule
      description: Create hibernation schedule
      operationId: HibernationSchedulesAPI_CreateHibernationSchedule
      parameters:
      - name: organizationId
        in: path
        description: ID of the organization that the hibernation job is for
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HibernationSchedule'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationSchedule'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
    get:
      tags:
      - HibernationSchedulesAPI
      summary: List hibernation schedules
      description: 'Gets the list of organization hibernation schedules

        Max page limit is 500.'
      operationId: HibernationSchedulesAPI_ListHibernationSchedules
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        required: true
        schema:
          type: string
      - name: page.limit
        in: query
        description: Defines the number of items that should be returned
        schema:
          type: string
      - name: page.cursor
        in: query
        description: "Cursor that defines token indicating where to start the next page.\n Empty value indicates to start from beginning of the dataset."
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListHibernationSchedulesResponse'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /cluster-autoscaler/v1beta/organizations/{organizationId}/hibernation-schedules/{id}:
    delete:
      tags:
      - HibernationSchedulesAPI
      summary: Delete a hibernation schedule
      description: Delete hibernation schedule
      operationId: HibernationSchedulesAPI_DeleteHibernationSchedule
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the hibernation schedule.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content: {}
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
    get:
      tags:
      - HibernationSchedulesAPI
      summary: Get a hibernation schedule
      description: Get hibernation schedule
      operationId: HibernationSchedulesAPI_GetHibernationSchedule
      parameters:
      - name: organizationId
        in: path
        description: The ID of the Organization.
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the hibernation schedule.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationSchedule'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
    patch:
      tags:
      - HibernationSchedulesAPI
      summary: Update a hibernation schedule
      description: Update hibernation schedule
      operationId: HibernationSchedulesAPI_UpdateHibernationSchedule
      parameters:
      - name: organizationId
        in: path
        description: ID of the organization that the hibernation job is for
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The ID of the hibernation schedule.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HibernationScheduleUpdate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationSchedule'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    ClusterAssignments:
      required:
      - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ClusterAssignment'
          description: Cluster assignments
      description: Cluster assignments
    NodeConfig:
      required:
      - instanceType
      type: object
      properties:
        instanceType:
          type: string
          description: Instance type of the node.
        spotConfig:
          allOf:
          - $ref: '#/components/schemas/NodeSpotConfig'
          description: Node spot configuration.
        zone:
          type: string
          description: Zone of the node.
        subnetId:
          type: string
          description: Node subnet ID.
        volume:
          allOf:
          - $ref: '#/components/schemas/NodeVolume'
          description: Node volume configuration.
        gpuConfig:
          allOf:
          - $ref: '#/components/schemas/GPUConfig'
          description: Node GPU configuration.
        kubernetesLabels:
          type: object
          additionalProperties:
            type: string
          description: Node Kubernetes labels.
        kubernetesTaints:
          type: array
          items:
            $ref: '#/components/schemas/Taint'
          description: Node Kubernetes taints.
        configName:
          type: string
          description: "Name reference of Node configuration (template)to be used for node creation.\n Superseded if Configuration ID reference is provided.\n Request will fail if several configurations with same name exists for a given cluster."
        configId:
          type: string
          description: ID reference of Node configuration (template) to be used for node creation. Supersedes Configuration Name.
        nodeAffinity:
          allOf:
          - $ref: '#/components/schemas/NodeAffinity'
          description: Node affinity options.
      description: NodeConfig specifies type of node to provision when resuming a cluster.
    GoogleProtobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
    KubernetesNodeAffinity:
      required:
      - key
      - values
      - operator
      type: object
      properties:
        key:
          type: string
          description: Key
        values:
          type: array
          items:
            type: string
          description: Values
        operator:
          enum:
          - OPERATOR_UNSPECIFIED
          - IN
          - NOT_IN
          - EXISTS
          - DOES_NOT_EXIST
          - GT
          - LT
          type: string
          description: Operator
          format: enum
      description: Node affinity
    ListHibernationSchedulesResponse:
      required:
      - items
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/HibernationSchedule'
          description: The list of hibernation schedules
        nextPageCursor:
          type: string
          description: The pagination cursor to retrieve the next page of hibernation schedules.
        totalCount:
          type: integer
          description: The total number of items.
          format: int32
      description: Response message for listing hibernation schedules
    NodeAffinity:
      type: object
      properties:
        dedicatedGroup:
          type: string
          description: The name of the dedicated group.
        affinity:
          type: array
          items:
            $ref: '#/components/schemas/KubernetesNodeAffinity'
          description: THe affinity rules required for choosing the group.
      description: NodeAffinity provides control over the assignment of individual nodes to dedicated host instances.
    PauseConfig:
      required:
      - enabled
      - schedule
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the configuration is enabled
        schedule:
          allOf:
          - $ref: '#/components/schemas/Schedule'
          description: Pause configuration schedule
      description: Pause configuration
    ClusterAssignment:
      required:
      - clusterId
      type: object
      properties:
        clusterId:
          type: string
          description: ID of the cluster
      description: Cluster assignment
    Schedule:
      required:
      - cronExpression
      type: object
      properties:
        cronExpression:
          type: string
          description: CRON expression
      description: Hibernate configuration schedule
    Status:
      type: object
      properties:
        code:
          type: integer
          description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
          format: int32
        message:
          type: string
          description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
        details:
          type: array
          items:
            $ref: '#/components/schemas/GoogleProtobufAny'
          description: A list of messages that carry the error details.  There is a common set of message types for APIs to use.
      description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
    RaidConfig:
      type: object
      properties:
        chunkSizeKb:
          type: integer
          description: "Specify the RAID0 chunk size in kilobytes, this parameter affects the read/write in the disk array and must be tailored\n for the type of data written by the workloads in the node. If not provided it will default to 64KB."
          format: int32
      description: "RaidConfig allow You have two or more devices, of approximately the same size, and you want to combine their storage capacity\n and also combine their performance by accessing them in parallel."
    NodeVolume:
      type: object
      properties:
        sizeGib:
          type: integer
          description: Volume size in GiB.
          format: int32
        raidConfig:
          allOf:
          - $ref: '#/components/schemas/RaidConfig'
          description: Storage Optmized disk configuration, if present RAID0 is selected
      description: NodeVolume defines node's local root volume configuration.
    NodeSpotConfig:
      type: object
      properties:
        spot:
          type: boolean
          description: Whether node should be created as spot instance.
        priceHourly:
          type: string
          description: Spot instance price. Applicable only for AWS nodes.
      description: NodeSpotConfig defines if node should be created as spot instance, and params for creation.
    ResumeConfig:
      required:
      - enabled
      - schedule
      - jobConfig
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the configuration is enabled
        schedule:
          allOf:
          - $ref: '#/components/schemas/Schedule'
          description: Pause configuration schedule
        jobConfig:
          allOf:
          - $ref: '#/components/schemas/ResumeJobConfig'
          description: Resume job configuration
      description: Resume configuration
    HibernationSchedule:
      required:
      - enabled
      - name
      - pauseConfig
      - resumeConfig
      - clusterAssignments
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: ID of the schedule
        organizationId:
          readOnly: true
          type: string
          description: ID of the organization that the hibernation schedule is for
        enabled:
          type: boolean
          description: Whether the schedule is enabled
        name:
          type: string
          description: Name of the schedule
        pauseConfig:
          allOf:
          - $ref: '#/components/schemas/PauseConfig'
          description: Pause configuration
        resumeConfig:
          allOf:
          - $ref: '#/components/schemas/ResumeConfig'
          description: Resume configuration
        clusterAssignments:
          allOf:
          - $ref: '#/components/schemas/ClusterAssignments'
          description: Cluster assignments
        createTime:
          readOnly: true
          type: string
          description: The creation time of the hibernation schedule
          format: date-time
        updateTime:
          readOnly: true
          type: string
          description: The update time of the hibernation schedule
          format: date-time
      description: Hibernation schedule
    HibernationScheduleUpdate:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether the schedule is enabled
        name:
          type: string
          description: Name of the schedule
        pauseConfig:
          allOf:
          - $ref: '#/components/schemas/PauseConfig'
          description: Pause configuration
        resumeConfig:
          allOf:
          - $ref: '#/components/schemas/ResumeConfig'
          description: Resume configuration
        clusterAssignments:
          allOf:
          - $ref: '#/components/schemas/ClusterAssignments'
          description: Cluster assignments
      description: Hibernation schedule update model
    Taint:
      required:
      - key
      - value
      - effect
      type: object
      properties:
        key:
          type: string
          description: Key
        value:
          type: string
          description: Value
        effect:
          type: string
          description: Effect
      description: Taint defines node taint in kubernetes cluster.
    GPUConfig:
      type: object
      properties:
        type:
          type: string
          description: GPU type.
        count:
          type: integer
          description: Number of GPUs.
          format: int32
      description: "GPUConfig describes instance GPU configuration.\n\n Required while provisioning GCP N1 instance types with GPU.\n Eg.: n1-standard-2 with 8 x NVIDIA Tesla K80"
    ResumeJobConfig:
      required:
      - nodeConfig
      type: object
      properties:
        nodeConfig:
          allOf:
          - $ref: '#/components/schemas/NodeConfig'
          description: Node configuration, that will be used to create cluster resumption nodes.
      description: Resume configuration
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-provenance:
  method: searched
  source: https://docs.cast.ai/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.cast.ai/reference/autoscalinghealthindicatorsapi_listhealthindicators.md
  - https://docs.cast.ai/reference/autoscalingwatchdogapi_reportwatchdogevents.md
  - https://docs.cast.ai/reference/clusteradvisorapi_cancelanalysis.md
  - https://docs.cast.ai/reference/clusteradvisorapi_createanalysis.md
  - https://docs.cast.ai/reference/clusteradvisorapi_getanalysis.md
  - https://docs.cast.ai/reference/clusteradvisorapi_getanalysisvariant.md
  - https://docs.cast.ai/reference/clusteradvisorapi_listanalyses.md
  - https://docs.cast.ai/reference/clusteradvisorapi_listanalysisvariants.md
  - https://docs.cast.ai/reference/hibernationjobsapi_createhibernationjob.md
  - https://docs.cast.ai/reference/hibernationjobsapi_gethibernationjob.md
  - https://docs.cast.ai/reference/hibernationjobsapi_pausecluster.md
  - https://docs.cast.ai/reference/hibernationjobsapi_resumecluster.md
  - https://docs.cast.ai/reference/hibernationschedulesapi_createhibernationschedule.md
  - https://docs.cast.ai/reference/hibernationschedulesapi_deletehibernationschedule.md
  - https://docs.cast.ai/reference/hibernationschedulesapi_gethibernationschedule.md
  - https://docs.cast.ai/reference/hibernationschedulesapi_listhibernationschedules.md
  - https://docs.cast.ai/reference/hibernationschedulesapi_updatehibernationschedule.md
  - https://docs.cast.ai/reference/nodetemplatesapi_updatecapacityreservationconstraints.md
  - https://docs.cast.ai/reference/policiesv2api_getclusterpolicies.md
  - https://docs.cast.ai/reference/policiesv2api_updateclusterpolicies.md
  - https://docs.cast.ai/reference/rebalancingconfigapi_searchrebalancingnodefilters.md
  - https://docs.cast.ai/reference/rebalancingconfigapi_searchrebalancingnodefiltervalues.md
  - https://docs.cast.ai/reference/rebalancingconfigapi_searchrebalancingnodes.md
  - https://docs.cast.ai/reference/rebalancingconfigapi_searchrebalancingworkloads.md
  merge:
    pages: 24
    deduped: 200
    conflicts_kept_first: 0