Skip to main content
POST
Save and Test Warm Hook

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys. User-session JWTs are not accepted by /v1/replica endpoints.

Path Parameters

environmentId
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.