Skip to main content
PATCH
/
admin
/
fairness
/
config
Update the account's per-customer fairness configuration
curl --request PATCH \
  --url https://dev.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://dev.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://dev.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://dev.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://dev.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://dev.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://dev.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
}

Authorizations

Authorization
string
header
required

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Query Parameters

FairnessEnabled
boolean
OverageEnabled
boolean
DefaultLineageWeight
integer<int32>
BurstPercent
integer<int32>

Body

application/json

SetFairnessConfig

FairnessEnabled
boolean
OverageEnabled
boolean
DefaultLineageWeight
integer<int32>
BurstPercent
integer<int32>

Response

200 - application/json

Success

FairnessConfigResponse

FairnessEnabled
boolean
OverageEnabled
boolean
DefaultLineageWeight
integer<int32>
BurstPercent
integer<int32>