Configure a hibernation override for a deployment

POST

Path parameters

organizationIdstringRequired

The Organization ID

deploymentIdstringRequired

The Deployment ID

Request

This endpoint expects an object.
isHibernatingbooleanRequired

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.

overrideUntildatetimeOptional

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

OK

isActivebooleanOptional

Whether the override is currently active or not

isHibernatingbooleanOptional

Whether to go into hibernation or not via the override rule

overrideUntildatetimeOptional

Timestamp till the override on the hibernation schedule is in effect

Built with