PlayFlow Cloud Documentation

Update server custom_data

curl --request POST \
  --url https://api.computeflow.cloud/api/v3/servers/{instance_id}/update \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "custom_data": {}
}
'

import requests

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

payload = { "custom_data": {} }
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({custom_data: {}})
};

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

	payload := strings.NewReader("{\n  \"custom_data\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.computeflow.cloud/api/v3/servers/{instance_id}/update")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_data\": {}\n}"

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

{
  "instance_id": "<string>",
  "name": "<string>",
  "status": "launching",
  "network_ports": [
    {
      "name": "<string>",
      "internal_port": 123,
      "external_port": 123,
      "protocol": "udp",
      "host": "<string>",
      "tls_enabled": true
    }
  ],
  "startup_args": "<string>",
  "service_type": "match_based",
  "compute_size": "<string>",
  "region": "<string>",
  "version_tag": "<string>",
  "version": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "stopped_at": "2023-11-07T05:31:56Z",
  "auto_restart": true,
  "custom_data": {},
  "ttl": 123,
  "is_pool_server": true,
  "pool_claimed_at": "2023-11-07T05:31:56Z",
  "match_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "status": 123,
  "detail": "<string>"
}

POST

api

servers

{instance_id}

update

Update server custom_data

curl --request POST \
  --url https://api.computeflow.cloud/api/v3/servers/{instance_id}/update \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "custom_data": {}
}
'

import requests

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

payload = { "custom_data": {} }
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({custom_data: {}})
};

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

	payload := strings.NewReader("{\n  \"custom_data\": {}\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.computeflow.cloud/api/v3/servers/{instance_id}/update")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_data\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_data\": {}\n}"

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

{
  "instance_id": "<string>",
  "name": "<string>",
  "status": "launching",
  "network_ports": [
    {
      "name": "<string>",
      "internal_port": 123,
      "external_port": 123,
      "protocol": "udp",
      "host": "<string>",
      "tls_enabled": true
    }
  ],
  "startup_args": "<string>",
  "service_type": "match_based",
  "compute_size": "<string>",
  "region": "<string>",
  "version_tag": "<string>",
  "version": 123,
  "started_at": "2023-11-07T05:31:56Z",
  "stopped_at": "2023-11-07T05:31:56Z",
  "auto_restart": true,
  "custom_data": {},
  "ttl": 123,
  "is_pool_server": true,
  "pool_claimed_at": "2023-11-07T05:31:56Z",
  "match_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "status": 123,
  "detail": "<string>"
}

Authorizations

api-key

string

header

required

Path Parameters

instance_id

string

required

Server instance ID to update.

Body

application/json

Fields that can be updated on a running server.

custom_data

object

Replace the server's custom_data with this value. Useful for updating match state, player counts, or any metadata your game needs to expose via the API.

Show child attributes

Response

Server updated with new custom_data.

Complete details of a game server instance, including connection info, status, and configuration.

instance_id

string

required

Unique identifier for this server instance (UUID). Use this to reference the server in all other API calls.

name

string

required

Display name of the server, as provided when starting.

status

enum<string>

required

Current server status. "launching": machine is being created and game is starting up. "running": game is ready and accepting connections. "stopped": server has been shut down.

Available options:

launching,

running,

stopped

network_ports

object[]

required

List of allocated network ports with connection details. Give host:external_port to game clients for connecting. Empty if the server has stopped.

Show child attributes

startup_args

string | null

required

Command-line arguments passed to the game executable. Null if none were provided.

service_type

enum<string>

required

Server type. "match_based" (default): short-lived servers for individual matches. "persistent_world": long-running servers for persistent game worlds.

Available options:

match_based,

persistent_world

compute_size

string

required

Machine size this server is running on (e.g., "small", "medium", "dedicated-large").

region

string

required

Region where this server is deployed (e.g., "us-east", "eu-west").

version_tag

string

required

Build name this server was started with (e.g., "default", "beta").

version

number | null

required

Build version number this server is running. Null if no specific version was resolved.

started_at

string<date-time> | null

required

ISO 8601 timestamp when the server transitioned to "running" status (game ports opened). Null if still launching or never reached running state.

stopped_at

string<date-time> | null

required

ISO 8601 timestamp when the server was stopped. Null if the server is still active.

auto_restart

boolean

required

Whether the game process auto-restarts on crash (max 10 retries).

custom_data

object | null

required

Arbitrary metadata attached to this server. Null if no custom data was provided.

Show child attributes

ttl

number | null

required

Time-to-live in seconds. The server auto-stops after this duration from start. Null if no TTL was set (server runs until explicitly stopped).

is_pool_server

boolean

required

Whether this server was claimed from the pre-provisioned pool. Pool servers have faster startup times (~5s vs ~30s).

pool_claimed_at

string<date-time> | null

required

ISO 8601 timestamp when this pool server was claimed for use. Null for non-pool servers or unclaimed pool machines.

match_id

string | null

required

Match identifier for matchmaking integration. Auto-generated if not provided at start time.

created_at

string<date-time>

required

ISO 8601 timestamp when the server instance was created in the database.

updated_at

string<date-time>

required

ISO 8601 timestamp of the last update to this server record.

Overview

Endpoints

Update server custom_data

Authorizations

Path Parameters

Body

Response