Configure a hibernation override for a deployment

POST

https://api.astronomer.io/platform/v1beta1/organizations/:organizationId/deployments/:deploymentId/hibernation-override

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The Organization ID

deploymentIdstringRequired

The Deployment ID

Request

This endpoint expects an object.

isHibernatingboolean or nullRequired

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.

overrideUntilstring or nullOptionalformat: "date-time"

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.

Response

isActiveboolean or null

Whether the override is currently active or not

isHibernatingboolean or null

Whether to go into hibernation or not via the override rule

overrideUntilstring or nullformat: "date-time"

Timestamp till the override on the hibernation schedule is in effect

Errors

4XX

Client Request Error

5XX

Server Error

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/hibernation-override \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"isHibernating": true
>	}'

$	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/hibernation-override \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"isHibernating": true
>	}'

1	{
2	"isActive": true,
3	"isHibernating": true,
4	"overrideUntil": "2024-12-31T23:59:59Z"
5	}