curl --request POST \
--url https://api.example.com/api/config/profiles/{name}/apply \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/config/profiles/{name}/apply"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/config/profiles/{name}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/config/profiles/{name}/apply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/config/profiles/{name}/apply"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/config/profiles/{name}/apply")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/config/profiles/{name}/apply")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"fanout": {
"mode": "<string>",
"error": "<string>",
"local_only": true,
"note": "<string>",
"op": "<string>",
"reachable": true,
"results": [
{
"name": "<string>",
"outcome": "<string>",
"detail": "<string>",
"error": "<string>",
"payload": null
}
]
},
"fresh": [
{
"generation": 123,
"kind": "<string>",
"name": "<string>"
}
],
"hot": [
"<string>"
],
"recycle": [
{
"generation_before": 123,
"kind": "<string>",
"name": "<string>",
"status": "<string>"
}
],
"refused": [
"<string>"
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "reloading — the server is applying a config reload; retry shortly",
"reloading": true
}Apply a settings profile — replace the stored env and reload the fleet
Apply the profile’s active env as the WHOLE stored env band (a key the profile omits is deleted, save the carried deployment X band), build+swap a fresh serving epoch under it, persist env-write-LAST, broadcast the reload, and recycle the fleet for recycle-class diffs. NO request body.
The response is the dedicated profileApplyResponse
{hot, recycle:[{name, kind, status, generation_before}], fresh:[{name, kind, generation}], refused:[] on success, fanout} — key names + worker identities only,
never env values. recycle is one line per recycled/timed-out sibling (plus the
applier’s own deferred self-exit line when it must self-exit); fresh is the
per-kind new ready lives observed since the pre-apply snapshot, capacity evidence never
claimed as any target’s successor. A refusal (X-band key, dangling !ENV, a recycle-
class diff the deployment shape cannot carry) aborts upfront with a loud 400 naming
the key, before anything is snapshotted, built, or persisted. When the diff carries
serve-affecting recycle keys the applier’s OWN recycle is armed as a post-response
graceful self-exit (a Starlette BackgroundTask) — its supervisor respawns it on
the new env. 404 for an absent name.
curl --request POST \
--url https://api.example.com/api/config/profiles/{name}/apply \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/config/profiles/{name}/apply"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/config/profiles/{name}/apply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/config/profiles/{name}/apply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/config/profiles/{name}/apply"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/config/profiles/{name}/apply")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/config/profiles/{name}/apply")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"fanout": {
"mode": "<string>",
"error": "<string>",
"local_only": true,
"note": "<string>",
"op": "<string>",
"reachable": true,
"results": [
{
"name": "<string>",
"outcome": "<string>",
"detail": "<string>",
"error": "<string>",
"payload": null
}
]
},
"fresh": [
{
"generation": 123,
"kind": "<string>",
"name": "<string>"
}
],
"hot": [
"<string>"
],
"recycle": [
{
"generation_before": 123,
"kind": "<string>",
"name": "<string>",
"status": "<string>"
}
],
"refused": [
"<string>"
]
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "reloading — the server is applying a config reload; retry shortly",
"reloading": true
}Authorizations
Path Parameters
Response
Success.
The dedicated profile-apply response. hot are the hot-class diff key
names; recycle the recycled/self-deferred worker lines; 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); fanout the
reload broadcast's fleet summary. Names only — never env values.
Show child attributes
Show child attributes

