Skip to main content
POST
Save and test warm hook

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.

Body

application/json
content
string
required

Shell script to save and execute

Response

Warm hook saved (test result included in body)

warm_hook
object
required

A warm hook — the shell script that runs while pre-warming workspaces for an environment.

test
object
required

Result of running a warm hook script in an isolated sandbox.