Cast AI Hibernation Jobs API

openapi: 3.2.0
info:
  title: Cluster Autoscaler Hibernation Jobs API
  version: 0.0.1
  description: HibernationJobsAPI handles interaction with cluster hibernation jobs.
servers:
- url: https://api.cast.ai/
  description: US endpoint
- url: https://api.eu.cast.ai/
  description: EU endpoint
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: HibernationJobsAPI
  description: HibernationJobsAPI handles interaction with cluster hibernation jobs.
paths:
  /cluster-autoscaler/v1/organizations/{organizationId}/clusters/{clusterId}/hibernation-jobs:
    post:
      tags:
      - HibernationJobsAPI
      summary: Create cluster hibernation job
      operationId: HibernationJobsAPI_CreateHibernationJob
      parameters:
      - name: organizationId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: mode
        in: query
        description: Mode of the operation.
        schema:
          enum:
          - OPERATION_MODE_UNSPECIFIED
          - OPERATION_MODE_DEFAULT
          - OPERATION_MODE_DRY_RUN
          type: string
          format: enum
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HibernationJob'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationJob'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /cluster-autoscaler/v1/organizations/{organizationId}/clusters/{clusterId}/hibernation-jobs/{id}:
    get:
      tags:
      - HibernationJobsAPI
      summary: Get cluster hibernation job by ID
      description: Get a cluster hibernation job by ID
      operationId: HibernationJobsAPI_GetHibernationJob
      parameters:
      - name: organizationId
        in: path
        description: ID of the organization that the hibernation job belongs to
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: ID of the cluster that the hibernation job belongs to
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of the hibernation job
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationJob'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /cluster-autoscaler/v1/organizations/{organizationId}/clusters/{clusterId}/hibernation-jobs:pauseCluster:
    post:
      tags:
      - HibernationJobsAPI
      summary: Initiate manual cluster pause through a hibernation job
      description: Requires an existing hibernation schedule, that is assigned to the cluster being resumed.
      operationId: HibernationJobsAPI_PauseCluster
      parameters:
      - name: organizationId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: mode
        in: query
        description: Mode of the operation.
        schema:
          enum:
          - OPERATION_MODE_UNSPECIFIED
          - OPERATION_MODE_DEFAULT
          - OPERATION_MODE_DRY_RUN
          type: string
          format: enum
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationJob'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /cluster-autoscaler/v1/organizations/{organizationId}/clusters/{clusterId}/hibernation-jobs:resumeCluster:
    post:
      tags:
      - HibernationJobsAPI
      summary: Initiate manual cluster resume through a hibernation job
      description: Requires an existing hibernation schedule, that is assigned to the cluster being resumed. The schedule's node configuration is used as the base for the resume node.
      operationId: HibernationJobsAPI_ResumeCluster
      parameters:
      - name: organizationId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: clusterId
        in: path
        description: ID of the cluster that the hibernation job is for
        required: true
        schema:
          type: string
      - name: mode
        in: query
        description: Mode of the operation.
        schema:
          enum:
          - OPERATION_MODE_UNSPECIFIED
          - OPERATION_MODE_DEFAULT
          - OPERATION_MODE_DRY_RUN
          type: string
          format: enum
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HibernationJob'
        default:
          description: Default error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
components:
  schemas:
    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).'
    HibernationJobError:
      type: object
      properties:
        message:
          readOnly: true
          type: string
          description: Error message
      description: HibernationJobError contains error information of a hibernation job
    HibernationJob:
      required:
      - type
      type: object
      properties:
        id:
          readOnly: true
          type: string
          description: The ID of the cluster hibernation job.
        organizationId:
          readOnly: true
          type: string
          description: The ID of the organization that the hibernation job belongs to.
        clusterId:
          readOnly: true
          type: string
          description: The ID of the cluster that the hibernation job belongs to.
        state:
          readOnly: true
          enum:
          - STATE_UNSPECIFIED
          - PENDING
          - PAUSING
          - FINISHED
          - FAILED
          - RESUMING
          type: string
          description: The state of the cluster hibernation job.
          format: enum
        type:
          enum:
          - TYPE_UNSPECIFIED
          - PAUSE
          - RESUME
          type: string
          description: The type of the cluster hibernation job.
          format: enum
        nodeConfig:
          allOf:
          - $ref: '#/components/schemas/NodeConfig'
          description: Node configuration, that will be used to create cluster resumption nodes.
        error:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/HibernationJobError'
          description: Job error information
        createTime:
          readOnly: true
          type: string
          description: The creation time of the cluster hibernation job.
          format: date-time
        updateTime:
          readOnly: true
          type: string
          description: The last update time of the cluster hibernation job.
          format: date-time
      description: Hibernation job model
    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.
    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"
    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
    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.
    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.
    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.
  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