> ## Documentation Index
> Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure a hibernation override for a deployment



## OpenAPI

````yaml /astro/api/v-1-beta-1/platform/openapi.yaml post /organizations/{organizationId}/deployments/{deploymentId}/hibernation-override
openapi: 3.0.3
info:
  contact: {}
  description: Astro Platform API
  title: Astro Platform API
  version: v1beta1
servers:
  - url: https://api.astronomer.io/platform/v1beta1
security:
  - JWT: []
tags:
  - description: >-
      A `cluster` object represents an Astro cluster, which is a Kubernetes
      cluster that hosts the infrastructure required to run Deployments. Make
      requests to `cluster` endpoints to manage your standard and dedicated
      clusters. See [Create a dedicated
      cluster](https://astronomer.io/docs/astro/create-dedicated-cluster).
    name: Cluster
  - description: >-
      The `organization` object contains the metadata and configurations of an
      Astro Organization. It does not include objects within the Organization,
      such as users and clusters. Make requests to `organization` endpoints to
      view and update high level settings for your Organization, including
      settings related to authentication and billing. To manage resources within
      an Organization, make requests to the endpoints related to those
      resources, such as `users`. See
      [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single
      sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage
      domains](https://astronomer.io/docs/astro/manage-domains).
    name: Organization
  - description: >-
      The `options` object represents all possible configurations for a given
      Astro component. Make requests to the `options` object to get the
      configuration constraints for creating or updating a given Astro
      component.
    name: Options
  - description: >-
      The `workspace` object represents an Astro Workspace, which is a
      collection of Deployments that can be accessed by a specific group of
      users. It contains metadata about a Workspace, but does not contain
      objects within the Workspace such as users and Deployments. Make requests
      to `workspace` endpoints to manage high level details about your
      Workspace. To manage resources within a Workspace, make requests to the
      endpoints related to those resources, such as `users`, and use the
      `workspaceIds` parameter to filter results by Workspace. See [Configure
      Workspaces](https://astronomer.io/docs/astro/manage-workspaces).
    name: Workspace
  - name: notification-channels
    x-group: Notification Channels
paths:
  /organizations/{organizationId}/deployments/{deploymentId}/hibernation-override:
    post:
      tags:
        - Deployment
      summary: Configure a hibernation override for a deployment
      operationId: UpdateDeploymentHibernationOverride
      parameters:
        - description: The Organization ID
          in: path
          name: organizationId
          required: true
          schema:
            type: string
        - description: The Deployment ID
          in: path
          name: deploymentId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OverrideDeploymentHibernationBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentHibernationOverride'
          description: OK
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: a common error response
        5XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: a common error response
      security:
        - JWT: []
components:
  schemas:
    OverrideDeploymentHibernationBody:
      properties:
        isHibernating:
          description: >-
            The type of override to perform. Set this value to 'true' to have
            the Deployment hibernate regardless of its hibernation schedule. Set
            the value to 'false' to have the Deployment wake up regardless of
            its hibernation schedule. Use 'OverrideUntil' to define the length
            of the override.
          nullable: true
          type: boolean
        overrideUntil:
          description: >-
            The end of the override time in UTC, formatted as
            'YYYY-MM-DDTHH:MM:SSZ'. If this value isn't specified, the override
            persists until you end it through the Astro UI or another API call.
          format: date-time
          nullable: true
          type: string
      required:
        - isHibernating
      type: object
    DeploymentHibernationOverride:
      properties:
        isActive:
          description: Whether the override is currently active or not
          nullable: true
          type: boolean
        isHibernating:
          description: Whether to go into hibernation or not via the override rule
          nullable: true
          type: boolean
        overrideUntil:
          description: Timestamp till the override on the hibernation schedule is in effect
          format: date-time
          nullable: true
          type: string
      type: object
    Error:
      properties:
        message:
          type: string
        requestId:
          type: string
        statusCode:
          maximum: 600
          minimum: 400
          type: integer
      required:
        - message
        - requestId
        - statusCode
      type: object
  securitySchemes:
    JWT:
      scheme: bearer
      type: http

````