Skip to main content
PATCH
/
api
/
v3
/
servers
/
{instance_id}
/
backfill
Override backfill state (server-authoritative)
curl --request PATCH \
  --url https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "accepting": true,
  "skillBand": {
    "field": "<string>",
    "min": 123,
    "max": 123
  }
}
'
import requests

url = "https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill"

payload = {
"accepting": True,
"skillBand": {
"field": "<string>",
"min": 123,
"max": 123
}
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({accepting: true, skillBand: {field: '<string>', min: 123, max: 123}})
};

fetch('https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill', 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.computeflow.cloud/api/v3/servers/{instance_id}/backfill",
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([
'accepting' => true,
'skillBand' => [
'field' => '<string>',
'min' => 123,
'max' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill"

payload := strings.NewReader("{\n \"accepting\": true,\n \"skillBand\": {\n \"field\": \"<string>\",\n \"min\": 123,\n \"max\": 123\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("api-key", "<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.computeflow.cloud/api/v3/servers/{instance_id}/backfill")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accepting\": true,\n \"skillBand\": {\n \"field\": \"<string>\",\n \"min\": 123,\n \"max\": 123\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accepting\": true,\n \"skillBand\": {\n \"field\": \"<string>\",\n \"min\": 123,\n \"max\": 123\n }\n}"

response = http.request(request)
puts response.read_body
{
  "match_id": "<string>",
  "instance_id": "<string>",
  "backfill_open": true,
  "backfill_deadline": "2023-11-07T05:31:56Z",
  "skill_band": {
    "field": "<string>",
    "min": 123,
    "max": 123
  },
  "roster_version": 123
}
{
"error": "<string>",
"status": 123,
"detail": "<string>"
}

Authorizations

api-key
string
header
required

Path Parameters

instance_id
string
required

Server instance ID (the game server's own INSTANCE_ID).

Body

application/json

Server-authoritative override of a match's backfill state.

accepting
boolean
required

Whether the match should accept backfill joiners. Set false to close backfill (server-authoritative override).

skillBand
object | null

Replace the match's skill band for joiners. Omit to leave the current band unchanged; null is treated as no change.

Response

Backfill state updated. The roster mirror and roster_version reflect the change.

Result of a server-authoritative backfill state change.

match_id
string
required

Identifier of the match that was updated.

instance_id
string | null
required

Server instance backing this match.

status
enum<string>
required

Match lifecycle status after the update.

Available options:
in_game,
locked,
completed
backfill_open
boolean
required

Whether the match is now accepting backfill joiners.

backfill_deadline
string<date-time> | null
required

ISO 8601 timestamp after which backfill closes. Null if no window is active.

skill_band
object | null
required

Current skill band applied to joiners, or null if none.

roster_version
integer
required

Monotonically increasing roster version after the update.