Skip to main content
POST
Restore warm pool snapshot

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

environment_id
string
required

Environment UUID, or the literal string global.

snapshot_id
string<uuid>
required

Snapshot record UUID from the snapshots array returned by GET /v1/environments/{environmentId}/warm-hooks.

Response

Snapshot restore started

warm_pool
object
required

Warm pool configuration plus current pool counts.

restored_generation
integer
required

Generation of the snapshot that was restored and is now installed