Skip to main content
PATCH
Update a template warm pool

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

warm_pool_id
string
required

Tenant warm-pool id.

Body

application/json
name
string
Required string length: 1 - 160
template_ref
string
template
string
deprecated
min_ready
integer
Required range: x >= 0
max_ready
integer
Required range: x >= 0
resources
object
checkout_policy
enum<string>
Available options:
prefer,
require,
bypass
idle_timeout_seconds
integer
Required range: x >= 1
stale_after_seconds
integer
Required range: x >= 1
version_policy
enum<string>
Available options:
pinned_build,
track_tag
track_tag
string | null
host_pool_id
string | null

Optional placement host-pool scope. Set or clear with cell_id; partial host-pool/cell/compatibility scope is rejected.

cell_id
string | null

Optional placement cell scope. Set or clear with host_pool_id; partial host-pool/cell/compatibility scope is rejected.

labels
object

Free-form user-supplied labels for pool selection/reporting; stored verbatim, deliberately open.

metadata
object

Free-form pool metadata; must be a JSON object and may carry poolable runtime keys, otherwise uninterpreted - deliberately open.

Response

Warm pool updated

id
string
required
Example:

"twp_review_pool"

name
string
required
template_ref
string
required
resolved_template
string
required
resources
object
required
min_ready
integer
required
max_ready
integer
required
idle_timeout_seconds
integer
required
stale_after_seconds
integer
required
checkout_policy
enum<string>
required
Available options:
prefer,
require,
bypass
version_policy
enum<string>
required
Available options:
pinned_build,
track_tag
rollout_generation
integer<int64>
required
rollout_status
object
required

Server-built rollout/count diagnostics (for example current_counts or observed_pool_counts). Deliberately open: the shape tracks the warm-pool controller.

status
object
required
state
enum<string>
required
Available options:
enabled,
disabled,
draining,
deleted
labels
object
required

Stored user-supplied pool labels; uninterpreted by the server, deliberately open.

metadata
object
required

Stored user-supplied pool metadata; uninterpreted by the server, deliberately open.

created_at
string<date-time>
required
updated_at
string<date-time>
required
resolved_template_build_id
string | null
runtime_artifact_id
string | null
host_pool_id
string | null
cell_id
string | null
compatibility_key
string | null
track_tag
string | null
previous_resolved_template
string | null
previous_resolved_template_build_id
string | null
previous_runtime_artifact_id
string | null
degraded_reason
enum<string> | null
Available options:
no_eligible_hosts,
artifact_not_ready,
artifact_prewarm_failed,
quota_exceeded,
template_build_unavailable,
controller_disabled,
drain_active
enabled_at
string<date-time> | null
disabled_at
string<date-time> | null
drain_requested_at
string<date-time> | null
last_reconciled_at
string<date-time> | null

Last time the warm-pool controller reconciled public status and rollout counts for this pool.

deleted_at
string<date-time> | null