Configure a hibernation override for a deployment
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"isHibernating": true,
"overrideUntil": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override"
payload = {
"isHibernating": True,
"overrideUntil": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({isHibernating: true, overrideUntil: '2023-11-07T05:31:56Z'})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'isHibernating' => true,
'overrideUntil' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override"
payload := strings.NewReader("{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"isActive": true,
"isHibernating": true,
"overrideUntil": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Deployment
Configure a hibernation override for a deployment
POST
/
organizations
/
{organizationId}
/
deployments
/
{deploymentId}
/
hibernation-override
Configure a hibernation override for a deployment
curl --request POST \
--url https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"isHibernating": true,
"overrideUntil": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override"
payload = {
"isHibernating": True,
"overrideUntil": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({isHibernating: true, overrideUntil: '2023-11-07T05:31:56Z'})
};
fetch('https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'isHibernating' => true,
'overrideUntil' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override"
payload := strings.NewReader("{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/deployments/{deploymentId}/hibernation-override")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"isHibernating\": true,\n \"overrideUntil\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"isActive": true,
"isHibernating": true,
"overrideUntil": "2023-11-07T05:31:56Z"
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>",
"requestId": "<string>",
"statusCode": 500,
"fieldErrors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The Organization ID
The Deployment ID
Body
application/json
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.
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.
Was this page helpful?
⌘I