curl --request GET \
--url https://api.computeflow.cloud/api/v3/projects/settings \
--header 'api-key: <api-key>'import requests
url = "https://api.computeflow.cloud/api/v3/projects/settings"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://api.computeflow.cloud/api/v3/projects/settings', 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/projects/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/projects/settings"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.computeflow.cloud/api/v3/projects/settings")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.computeflow.cloud/api/v3/projects/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"port_configs": [
{
"name": "<string>",
"internal_port": 32768,
"protocol": "udp",
"tls_enabled": true,
"id": "<string>"
}
],
"auth_config": {
"provider": "none"
},
"environment_variables": {},
"pool_config": {
"enabled": true,
"regions": {},
"build_name": "<string>",
"build_version": 2
},
"lobby_configs": [
{
"id": "<string>",
"name": "<string>",
"enabled": true,
"timeout": 2,
"heartbeat": true,
"heartbeatTimeout": 123,
"hostLeaveBehavior": "promote",
"customProperties": {},
"inviteCodeConfig": {
"type": "numeric",
"length": 8,
"prefix": "<string>"
},
"serverSettings": {},
"matchmaking": {
"modes": {}
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"status": 123,
"detail": "<string>"
}Get project settings
Returns the complete project configuration including network ports, player authentication, default environment variables, server pool settings, and lobby/matchmaking rules.
These settings are applied as defaults to every server started in this project. Individual settings can be overridden per-server at start time.
curl --request GET \
--url https://api.computeflow.cloud/api/v3/projects/settings \
--header 'api-key: <api-key>'import requests
url = "https://api.computeflow.cloud/api/v3/projects/settings"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://api.computeflow.cloud/api/v3/projects/settings', 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/projects/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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/projects/settings"
req, _ := http.NewRequest("GET", 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))
}HttpResponse<String> response = Unirest.get("https://api.computeflow.cloud/api/v3/projects/settings")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.computeflow.cloud/api/v3/projects/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"port_configs": [
{
"name": "<string>",
"internal_port": 32768,
"protocol": "udp",
"tls_enabled": true,
"id": "<string>"
}
],
"auth_config": {
"provider": "none"
},
"environment_variables": {},
"pool_config": {
"enabled": true,
"regions": {},
"build_name": "<string>",
"build_version": 2
},
"lobby_configs": [
{
"id": "<string>",
"name": "<string>",
"enabled": true,
"timeout": 2,
"heartbeat": true,
"heartbeatTimeout": 123,
"hostLeaveBehavior": "promote",
"customProperties": {},
"inviteCodeConfig": {
"type": "numeric",
"length": 8,
"prefix": "<string>"
},
"serverSettings": {},
"matchmaking": {
"modes": {}
}
}
],
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"status": 123,
"detail": "<string>"
}Authorizations
Response
Complete current project settings.
Complete current project settings including ports, auth, environment, pool, and lobby configurations.
Current network port configuration for the project.
Show child attributes
Show child attributes
Current player authentication configuration.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Current default environment variables for all servers.
Show child attributes
Show child attributes
Current server pool configuration. Null if pooling has never been configured.
Show child attributes
Show child attributes
Current lobby and matchmaking configurations.
Show child attributes
Show child attributes
ISO 8601 timestamp of the last settings update.