Deployment

Configure a hibernation override for a deployment

POST

Path parameters

organizationIdstringRequired
The Organization ID
deploymentIdstringRequired
The Deployment ID

Request

This endpoint expects an object.
isHibernating
booleanRequired
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.
overrideUntil
datetimeOptional
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

This endpoint returns an object
isActive
booleanOptional
Whether the override is currently active or not
isHibernating
booleanOptional
Whether to go into hibernation or not via the override rule
overrideUntil
datetimeOptional
Timestamp till the override on the hibernation schedule is in effect
POST
1curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/deployments/deploymentId/hibernation-override \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "isHibernating": true
6}'
Response
1{
2  "isActive": true,
3  "isHibernating": true,
4  "overrideUntil": "2024-01-15T09:30:00Z"
5}
Built with