Register Worker

Register a new worker with the control plane.

This endpoint is called by workers on startup to get their configuration. The worker authenticates using KUBIYA_API_KEY (same auth as other API calls).

Returns: All configuration needed for worker to connect to Temporal and operate:

• worker_id: Unique ID for this worker instance
• worker_token: Environment’s worker token
• environment_name: Formatted task queue name (org_id.environment)
• temporal_namespace, temporal_host, temporal_api_key: Temporal Cloud config
• organization_id: Organization ID
• control_plane_url: URL to send heartbeats

POST /api/v1/workers/register

Register Worker

cURL

curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/workers/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment_name": "<string>",
  "hostname": "<string>",
  "worker_metadata": {}
}
'

200

{
  "worker_id": "<string>",
  "worker_token": "<string>",
  "environment_name": "<string>",
  "temporal_namespace": "<string>",
  "temporal_host": "<string>",
  "temporal_api_key": "<string>",
  "organization_id": "<string>",
  "control_plane_url": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your Kubiya API token (format: Bearer )

Body

application/json

Worker registration request

environment_name · string · required

hostname · string | null

worker_metadata · Worker Metadata · object

Response

200

application/json

Successful Response

Worker registration response with all config needed

worker_id · string · required

worker_token · string · required

environment_name · string · required

temporal_namespace · string · required

temporal_host · string · required

temporal_api_key · string · required

organization_id · string · required

control_plane_url · string · required