Update a forecast
PUT
/v1/forecast/{id}/
const url = 'https://example.com/v1/forecast/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"configuration":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","failed_at":"2026-04-15T12:00:00Z","predicted_critical_threshold":"2026-04-15T12:00:00Z","predicted_shortage":"2026-04-15T12:00:00Z","predicted_warning_threshold":"2026-04-15T12:00:00Z","ran_at":"2026-04-15T12:00:00Z","threshold_critical":1,"threshold_shortage":1,"threshold_warning":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://example.com/v1/forecast/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "configuration": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "failed_at": "2026-04-15T12:00:00Z", "predicted_critical_threshold": "2026-04-15T12:00:00Z", "predicted_shortage": "2026-04-15T12:00:00Z", "predicted_warning_threshold": "2026-04-15T12:00:00Z", "ran_at": "2026-04-15T12:00:00Z", "threshold_critical": 1, "threshold_shortage": 1, "threshold_warning": 1 }'Replace all fields of an existing forecast.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
A UUID string identifying this forecast.
Request Bodyrequired
Section titled “Request Bodyrequired”A ModelSerializer that takes an additional fields argument that
controls which fields should be displayed.
object
account
required
string format: uuid
configuration
required
string format: uuid
failed_at
string format: date-time
id
required
string format: uuid
modified_at
required
string format: date-time
predicted_critical_threshold
Predicted critical threshold datetime
string format: date-time
predicted_shortage
Predicted shortage datetime
string format: date-time
predicted_warning_threshold
Predicted warning threshold datetime
string format: date-time
promql_query
required
string
ran_at
string format: date-time
threshold_critical
number format: double
threshold_shortage
number format: double
threshold_warning
number format: double
Examplegenerated
{ "configuration": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "failed_at": "2026-04-15T12:00:00Z", "predicted_critical_threshold": "2026-04-15T12:00:00Z", "predicted_shortage": "2026-04-15T12:00:00Z", "predicted_warning_threshold": "2026-04-15T12:00:00Z", "ran_at": "2026-04-15T12:00:00Z", "threshold_critical": 1, "threshold_shortage": 1, "threshold_warning": 1}A ModelSerializer that takes an additional fields argument that
controls which fields should be displayed.
object
account
required
string format: uuid
configuration
required
string format: uuid
failed_at
string format: date-time
id
required
string format: uuid
modified_at
required
string format: date-time
predicted_critical_threshold
Predicted critical threshold datetime
string format: date-time
predicted_shortage
Predicted shortage datetime
string format: date-time
predicted_warning_threshold
Predicted warning threshold datetime
string format: date-time
promql_query
required
string
ran_at
string format: date-time
threshold_critical
number format: double
threshold_shortage
number format: double
threshold_warning
number format: double
Responses
Section titled “Responses”Media typeapplication/json
A ModelSerializer that takes an additional fields argument that
controls which fields should be displayed.
object
account
required
string format: uuid
configuration
required
string format: uuid
failed_at
string format: date-time
id
required
string format: uuid
modified_at
required
string format: date-time
predicted_critical_threshold
Predicted critical threshold datetime
string format: date-time
predicted_shortage
Predicted shortage datetime
string format: date-time
predicted_warning_threshold
Predicted warning threshold datetime
string format: date-time
promql_query
required
string
ran_at
string format: date-time
threshold_critical
number format: double
threshold_shortage
number format: double
threshold_warning
number format: double
Examplegenerated
{ "configuration": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "failed_at": "2026-04-15T12:00:00Z", "predicted_critical_threshold": "2026-04-15T12:00:00Z", "predicted_shortage": "2026-04-15T12:00:00Z", "predicted_warning_threshold": "2026-04-15T12:00:00Z", "ran_at": "2026-04-15T12:00:00Z", "threshold_critical": 1, "threshold_shortage": 1, "threshold_warning": 1}