Skip to main content
POST
Add/remove names on the api_tools include/exclude lists and hot-reload

Authorizations

x-api-key
string
header
required

Body

application/json

Names to add to / remove from the manifest api_tools include and exclude lists.

Each field is a bare name list; all four empty is refused.

exclude_add
string[]
exclude_remove
string[]
include_add
string[]
include_remove
string[]

Response

Success.

data
ApplyResponse · object
required

The standard mutation-op response: this worker's local reload result merged with the fleet fan-out summary.

env_keys is the count of env keys the reload loaded. recycle is the fleet recycle roll the change ran — null when it 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. awaiting_respawn is the operation's verdict: the workers still awaiting a respawn after it (name + keys) — when the roll converged and this worker recycles itself, 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; a worker the roll did not reach keeps its keys. 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 is null 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.