Skip to main content
POST
/
v1
/
environments
/
{environmentId}
/
warm-hooks
/
save
Save Warm Hook
curl --request POST \
  --url https://api.tryreplicas.com/v1/environments/{environmentId}/warm-hooks/save \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "content": "<string>"
}
'
{
  "warm_hook": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 123,
    "content": "<string>",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
environmentId
string
required

Environment UUID, or the literal string global.

Body

application/json
​
content
string
required

Shell script to persist and activate

Response

Warm hook saved and activated

​
warm_hook
object
required

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