Sign in

v41

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-055374134.9 KB

Hold off auto-standby

Places a hold that prevents the auto-standby controller from putting the instance into standby before hold_until, and cancels any queued auto-standby attempt.

Each hold replaces the instance's previous hold, so hold_until always reflects the most recent call. Holding again after the policy's idle_timeout is shortened moves hold_until earlier.

Callers may use this before opening a connection to a candidate-idle instance: a 200 means it is safe to connect until hold_until; a 409 means the instance is in standby (or irrevocably entering it) and must be restored first.

Instances where auto-standby is disabled, unconfigured, or unsupported return 200 with their current status because no auto-standby will occur.

post/instances/{id}/auto-standby/hold

Path parameters

idstring required

Instance ID or name

Response

Hold placed (or nothing to hold); safe to connect until hold_until

supportedboolean required

Whether the current host platform supports auto-standby diagnostics.

configuredboolean required

Whether the instance has any auto-standby policy configured.

enabledboolean required

Whether the configured auto-standby policy is enabled.

eligibleboolean required

Whether the instance is currently eligible to enter standby.

status'unsupported' | 'disabled' | 'ineligible' | 'active' | 'idle_countdown' | 'ready_for_standby' | 'standby_requested' | 'error' required
reason'unsupported_platform' | 'policy_missing' | 'policy_disabled' | 'instance_not_running' | 'network_disabled' | 'missing_ip' | 'has_vgpu' | 'active_inbound_connections' | 'idle_timeout_not_elapsed' | 'observer_error' | 'ready_for_standby' required
active_inbound_connectionsinteger required

Number of currently tracked qualifying inbound TCP connections.

idle_timeoutstring nullable

Configured idle timeout from the auto-standby policy.

idle_sincestring date-time nullable

When the controller most recently observed the instance become idle.

last_inbound_activity_atstring date-time nullable

Timestamp of the most recent qualifying inbound TCP activity the controller observed.

next_standby_atstring date-time nullable

When the controller expects to attempt standby next, if a countdown is active.

hold_untilstring date-time nullable

Until when auto-standby is held off, if a hold is active.

countdown_remainingstring nullable

Remaining time before the controller attempts standby, when applicable.

tracking_modestring required

Diagnostic identifier for the runtime tracking mode in use.

Example response

{
  "supported": true,
  "configured": true,
  "enabled": true,
  "eligible": true,
  "status": "idle_countdown",
  "reason": "idle_timeout_not_elapsed",
  "idle_timeout": "5m0s",
  "idle_since": "2026-04-06T17:04:05Z",
  "last_inbound_activity_at": "2026-04-06T17:01:05Z",
  "next_standby_at": "2026-04-06T17:09:05Z",
  "hold_until": "2026-04-06T17:09:05Z",
  "countdown_remaining": "4m0s",
  "tracking_mode": "conntrack_events_v4_tcp"
}