curl --request GET \
--url https://api.simpl.gg/v1/builds/{build_id} \
--header 'api-key: <api-key>'import requests
url = "https://api.simpl.gg/v1/builds/{build_id}"
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.simpl.gg/v1/builds/{build_id}', 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.simpl.gg/v1/builds/{build_id}",
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.simpl.gg/v1/builds/{build_id}"
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.simpl.gg/v1/builds/{build_id}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/builds/{build_id}")
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{
"build_id": "build_9f2c",
"name": "1.2.3",
"version": 12,
"status": "uploading",
"build_type": "zip",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"executable_path": "Linux/GameServer.sh",
"image_url": "registry.example.com/game/server:1.2.3",
"error_message": "No executable found at Linux/GameServer.sh",
"base_version": "2"
}Get a build
curl --request GET \
--url https://api.simpl.gg/v1/builds/{build_id} \
--header 'api-key: <api-key>'import requests
url = "https://api.simpl.gg/v1/builds/{build_id}"
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.simpl.gg/v1/builds/{build_id}', 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.simpl.gg/v1/builds/{build_id}",
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.simpl.gg/v1/builds/{build_id}"
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.simpl.gg/v1/builds/{build_id}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/builds/{build_id}")
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{
"build_id": "build_9f2c",
"name": "1.2.3",
"version": 12,
"status": "uploading",
"build_type": "zip",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"executable_path": "Linux/GameServer.sh",
"image_url": "registry.example.com/game/server:1.2.3",
"error_message": "No executable found at Linux/GameServer.sh",
"base_version": "2"
}Authorizations
Per-project server key, prefixed sk_live_. Full access to every
endpoint. Keep it on your backend: never ship it in a game binary.
Path Parameters
Build identifier.
"build_9f2c"
Response
The build.
"build_9f2c"
Build name. Servers reference this as version_tag.
"1.2.3"
Monotonic integer version assigned per build name.
12
uploading, processing, ready, failed, deleted zip, docker_image Path to the server executable inside the ZIP. zip builds only.
"Linux/GameServer.sh"
Docker image reference. docker_image builds only.
"registry.example.com/game/server:1.2.3"
Why the build failed, when status is failed. Null otherwise.
One sentence, and the whole explanation: build output is not stored. It is on every build so that a client rendering a list of builds can say what went wrong without a second call per failed row.
"No executable found at Linux/GameServer.sh"
Which Simpl base the build's entrypoint comes from: the base a zip
build was built on, or the base a docker_image build was wrapped
with. That entrypoint runs in front of the game, so this answers
which runtime contract the build's servers get. The build is pinned
to that base: publishing a newer one never changes a build that
exists.
Null for builds that have not been built yet, for docker_image
builds registered before Docker images were wrapped, and for some
builds made before this field existed.
"2"