Skip to main content
GET
/
v1
/
environments
/
{environmentId}
/
warm-hooks
Get Warm Hooks State
curl --request GET \
  --url https://api.tryreplicas.com/v1/environments/{environmentId}/warm-hooks \
  --header 'Authorization: Bearer <token>'
{
  "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"
  },
  "warm_pool": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "target_size": 123,
    "generation": 123,
    "error_count": 123,
    "next_retry_at": "2023-11-07T05:31:56Z",
    "last_error_at": "2023-11-07T05:31:56Z",
    "last_error_message": "<string>",
    "has_base_snapshot": true,
    "updated_at": "2023-11-07T05:31:56Z",
    "ready_count": 123,
    "stale_count": 123,
    "warming_count": 123,
    "snapshotting_count": 123,
    "last_failure_at": "2023-11-07T05:31:56Z",
    "last_failure_reason": "<string>"
  }
}

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.

Response

Successful response

​
warm_hook
object
required

The active warm hook for the environment (null if none has ever been saved).

​
warm_pool
object
required

The warm pool config and current counts (null if no pool has been configured).