Skip to main content
POST
Apply a settings profile — replace the stored env and reload the fleet

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

Response

Success.

data
ProfileApplyResponse · object
required

The dedicated profile-apply response.

hot are the hot-class diff key names; recycle the worker lines of the recycle roll (empty when the roll had no worker to visit: every worker's reload confirmed no recycle-class key moved off its bound value, or the only ones naming one were refused at their epoch build or are the writer whose own restart cannot follow as its exit); skipped the workers so confirmed, left running; fresh the new ready lives seen since the pre-apply snapshot; refused is empty on success (any refusal aborts the pipeline before a response is built); recycle_stopped is null when the roll ran to its end, otherwise where it stopped and why; awaiting_respawn the workers still awaiting a respawn after the apply (name + keys; when the roll converged, only the workers whose reload was refused at their epoch build: the stored config did not build on them and a restart may fail the same way, so the roll leaves them running and lists them); fanout the reload broadcast's fleet summary. Names only — never env values. roll_deferred is true when the roll is not judged in this reply: roll_deferred_to then names the worker that carries it out after the reply (recycle and awaiting_respawn empty), and is null otherwise. span_release_error is null when the config store released its exclusive write span after the persist; otherwise the store's error — the change landed and the reload, broadcast and roll reported here still ran, but the store may still hold its write span until the writer process exits, so a later write can block or be refused until then.