Coolify Octri Demo
PATCH/servers/{uuid}/sentinel

Update Sentinel settings

Updates Sentinel settings for a server owned by the authenticated team. Use the body fields to configure metrics, GeoIP, traffic retention, and Sentinel behaviour; traffic_ip_mode accepts full, anonymized, or off. Changing the token or metrics timing fields may restart Sentinel, and the token must have the write and deploy permissions.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 15 body fields
uuidstringrequired
The UUID of the server whose Sentinel settings you want to update.

Sentinel settings to update. The schema does not designate any fields as required.

geoip_maxmind_license_keystringoptional
MaxMind license key for GeoIP data, or null to clear it.
geoip_refresh_daysintegeroptional
Number of days between GeoIP refreshes. Must be at least 1.
is_geoip_enabledbooleanoptional
Whether GeoIP is enabled.
is_metrics_enabledbooleanoptional
Whether Sentinel metrics collection is enabled.
is_sentinel_debug_enabledbooleanoptional
Whether Sentinel debug logging is enabled.
sentinel_custom_urlstringoptional
Custom Sentinel URL, or null to clear it.
sentinel_metrics_history_daysintegeroptional
Number of days of metrics history to retain. Must be at least 1.
sentinel_metrics_refresh_rate_secondsintegeroptional
Interval between metrics refreshes, in seconds. Must be at least 1.
sentinel_push_interval_secondsintegeroptional
Interval between Sentinel pushes, in seconds. Must be at least 10.
sentinel_tokenstringoptional
Token used by Sentinel.
traffic_ip_modestringoptional
How Sentinel stores client IPs: full, anonymized (IPv4 /24, IPv6 /48), or off.
Allowed:fullanonymizedoff
traffic_retention_1d_daysintegeroptional
Traffic retention period for daily data, in days. Must be between 1 and 3650.
traffic_retention_1h_daysintegeroptional
Traffic retention period for hourly data, in days. Must be between 1 and 365.
traffic_sample_thresholdintegeroptional
Traffic sampling threshold. Must be at least 0.
traffic_topnintegeroptional
Maximum number of top traffic entries. Must be between 1 and 1000.

6 status codes
200Returns confirmation that the Sentinel settings were updated.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the token lacks the write and deploy permissions.
404Returned when the server resource is not found.
messagestringoptional
422Returned when a Sentinel setting fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 is returned when the request is unauthenticated. A 403 is returned when the token lacks the write and deploy permissions; a 404 is returned when the server is not found. A 422 is returned when a setting fails validation. The uuid path parameter must identify a server; numeric settings must meet their stated minimums and maximums, and traffic_ip_mode must be full, anonymized, or off.