Skip to main content
POST
/
v1
/
template-warm-pools
Create a template warm pool
import requests

url = "https://api.13-215-85-171.sslip.io/v1/template-warm-pools"

payload = {
    "name": "<string>",
    "template_ref": "<string>",
    "min_ready": 1,
    "max_ready": 1,
    "resources": {
        "vcpus": 2,
        "memory_mb": 2,
        "disk_mb": 2
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "twp_review_pool",
  "name": "<string>",
  "template_ref": "<string>",
  "resolved_template": "<string>",
  "resources": {
    "vcpus": 2,
    "memory_mb": 2,
    "disk_mb": 2
  },
  "min_ready": 123,
  "max_ready": 123,
  "idle_timeout_seconds": 123,
  "stale_after_seconds": 123,
  "rollout_generation": 123,
  "rollout_status": {},
  "status": {
    "target": 123,
    "ready": 123,
    "warming": 123,
    "claimed": 123,
    "draining": 123,
    "failed": 123,
    "expired": 123,
    "unavailable": 123
  },
  "labels": {},
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "resolved_template_build_id": "<string>",
  "runtime_artifact_id": "<string>",
  "host_pool_id": "<string>",
  "cell_id": "<string>",
  "compatibility_key": "<string>",
  "track_tag": "<string>",
  "previous_resolved_template": "<string>",
  "previous_resolved_template_build_id": "<string>",
  "previous_runtime_artifact_id": "<string>",
  "enabled_at": "2023-11-07T05:31:56Z",
  "disabled_at": "2023-11-07T05:31:56Z",
  "drain_requested_at": "2023-11-07T05:31:56Z",
  "last_reconciled_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Body

application/json
​
name
string
required
Required string length: 1 - 160
​
template_ref
string
required

Built-in template name, custom template ref, tag, or build-qualified ref.

​
min_ready
integer
required

Minimum ready sandboxes to maintain.

Required range: x >= 0
​
max_ready
integer
required

Maximum warming/ready capacity for this pool. Must be greater than or equal to min_ready.

Required range: x >= 0
​
resources
object
required
​
template
string
deprecated

Alias for template_ref retained for SDK compatibility.

​
checkout_policy
enum<string>
default:prefer
Available options:
prefer,
require,
bypass
​
idle_timeout_seconds
integer
default:600
Required range: x >= 1
​
stale_after_seconds
integer
default:900
Required range: x >= 1
​
version_policy
enum<string>
default:pinned_build
Available options:
pinned_build,
track_tag
​
track_tag
string

Required when version_policy is track_tag unless the template ref includes a tag.

​
host_pool_id
string
​
cell_id
string
​
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 created

​
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