Skip to main content
POST
/
v1
/
knowledge-gaps
/
clusters
/
{cluster_id}
/
status
Transition a cluster through the lifecycle state machine
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/knowledge-gaps/clusters/{cluster_id}/status \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "note": "<string>",
  "target_cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_status": "<string>",
  "to_status": "<string>",
  "actor_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
cluster_id
string<uuid>
required

Body

application/json

Body for POST /clusters/{cluster_id}/status.

target_cluster_id is required when to_status='merged' and ignored otherwise. The state-machine enforcement lives in GapClusterLifecycleService; this schema only constrains the wire shape.

​
to_status
enum<string>
required
Available options:
acknowledged,
in_progress,
fixed,
reopened,
merged,
archived
​
note
string | null
Maximum string length: 1000
​
target_cluster_id
string<uuid> | null

Required when to_status == 'merged'; ignored otherwise.

Response

Successful Response

Wire shape for a successful lifecycle mutation.

Mirrors ClusterTransitionResult from the lifecycle service with enum statuses flattened to their string values for SDK ergonomics.

​
cluster_id
string<uuid>
required
​
from_status
string
required
​
to_status
string
required
​
actor_user_id
string<uuid> | null
required
​
event_id
string<uuid> | null
required