Update the account's per-customer fairness configuration
curl --request PATCH \
--url https://api.nestapi.com/admin/fairness/config \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123
}
'import requests
url = "https://api.nestapi.com/admin/fairness/config"
payload = {
"FairnessEnabled": True,
"OverageEnabled": True,
"DefaultLineageWeight": 123,
"BurstPercent": 123
}
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
FairnessEnabled: true,
OverageEnabled: true,
DefaultLineageWeight: 123,
BurstPercent: 123
})
};
fetch('https://api.nestapi.com/admin/fairness/config', 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.nestapi.com/admin/fairness/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'FairnessEnabled' => true,
'OverageEnabled' => true,
'DefaultLineageWeight' => 123,
'BurstPercent' => 123
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nestapi.com/admin/fairness/config"
payload := strings.NewReader("{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.nestapi.com/admin/fairness/config")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nestapi.com/admin/fairness/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}"
response = http.request(request)
puts response.read_body{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}Fairness
Update the account's per-customer fairness configuration
Admin only. Only the fields you supply are changed. Available on trials too, where overage has no effect until the account is on a paid plan.
Body (all optional; omitted fields are left unchanged)
FairnessEnabled— turn the per-customer admission gate on or off.OverageEnabled— keep nesting once the allowance and credit are used, billed as overage to the account’s card at the end of each monthly window. Turning it on requires a card on file (400 otherwise).DefaultLineageWeight— default per-key weight for keys with no override (≥ 1).BurstPercent— percent of included minutes kept as the shared first-come burst pool (0–100).
PATCH
/
admin
/
fairness
/
config
Update the account's per-customer fairness configuration
curl --request PATCH \
--url https://api.nestapi.com/admin/fairness/config \
--header 'Accept: <accept>' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123
}
'import requests
url = "https://api.nestapi.com/admin/fairness/config"
payload = {
"FairnessEnabled": True,
"OverageEnabled": True,
"DefaultLineageWeight": 123,
"BurstPercent": 123
}
headers = {
"Accept": "<accept>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Accept: '<accept>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
FairnessEnabled: true,
OverageEnabled: true,
DefaultLineageWeight: 123,
BurstPercent: 123
})
};
fetch('https://api.nestapi.com/admin/fairness/config', 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.nestapi.com/admin/fairness/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'FairnessEnabled' => true,
'OverageEnabled' => true,
'DefaultLineageWeight' => 123,
'BurstPercent' => 123
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nestapi.com/admin/fairness/config"
payload := strings.NewReader("{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Accept", "<accept>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.nestapi.com/admin/fairness/config")
.header("Accept", "<accept>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nestapi.com/admin/fairness/config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"FairnessEnabled\": true,\n \"OverageEnabled\": true,\n \"DefaultLineageWeight\": 123,\n \"BurstPercent\": 123\n}"
response = http.request(request)
puts response.read_body{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}{
"FairnessEnabled": true,
"OverageEnabled": true,
"DefaultLineageWeight": 123,
"BurstPercent": 123,
"HasCardOnFile": true
}Authorizations
Headers
Accept Header
Available options:
application/json Query Parameters
Body
application/json
Response
The updated fairness configuration.
FairnessConfigResponse
Whether the per-customer admission gate is active for the account.
Whether over-share nests spill into overage rather than being rejected.
Default per-key fairness weight for keys with no override.
Percent of included minutes kept as the shared first-come burst pool.
Whether the account has a payment card on file. Overage can only be turned on with one.