Skip to main content
POST
/
work_pools
/
{work_pool_name}
/
workers
/
heartbeat
Worker Heartbeat
curl --request POST \
  --url https://api.example.com/work_pools/{work_pool_name}/workers/heartbeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "heartbeat_interval_seconds": 123
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
work_pool_name
string
required

The work pool name

Body

application/json
​
name
string
required

The worker process name

​
heartbeat_interval_seconds
integer | null

The worker's heartbeat interval in seconds

Response

Successful Response