Skip to main content
POST
Restore Warm Pool Snapshot

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.

Path Parameters

environmentId
string
required

Environment UUID, or the literal string global.

snapshotId
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