PlayFlow Cloud Documentation

Close backfill (server-authoritative)

curl --request POST \
  --url https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock \
  --header 'api-key: <api-key>'

import requests

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

headers = {"api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'api-key': '<api-key>'}};

fetch('https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock', 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/lock",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "match_id": "<string>",
  "instance_id": "<string>",
  "status": "in_game",
  "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>"
}

POST

api

servers

{instance_id}

backfill

lock

Close backfill (server-authoritative)

curl --request POST \
  --url https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock \
  --header 'api-key: <api-key>'

import requests

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

headers = {"api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'api-key': '<api-key>'}};

fetch('https://api.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock', 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/lock",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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.computeflow.cloud/api/v3/servers/{instance_id}/backfill/lock"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "match_id": "<string>",
  "instance_id": "<string>",
  "status": "in_game",
  "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).

Response

Backfill closed. 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.

Show child attributes

roster_version

integer

required

Monotonically increasing roster version after the update.

Overview

Endpoints

Close backfill (server-authoritative)

Authorizations

Path Parameters

Response