Register a Docker image build
curl --request POST \
--url https://api.simpl.gg/v1/builds/docker-image \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "1.2.3",
"image_url": "registry.example.com/game/server:1.2.3"
}
'import requests
url = "https://api.simpl.gg/v1/builds/docker-image"
payload = {
"name": "1.2.3",
"image_url": "registry.example.com/game/server:1.2.3"
}
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({name: '1.2.3', image_url: 'registry.example.com/game/server:1.2.3'})
};
fetch('https://api.simpl.gg/v1/builds/docker-image', 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/docker-image",
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([
'name' => '1.2.3',
'image_url' => 'registry.example.com/game/server:1.2.3'
]),
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.simpl.gg/v1/builds/docker-image"
payload := strings.NewReader("{\n \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\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.simpl.gg/v1/builds/docker-image")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/builds/docker-image")
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 \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\n}"
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"
}Builds
Register a Docker image build
Registers an existing Docker image as a build. Simpl pulls the image,
validates it, and mounts /simpl/its_simpl.json into every container it
launches, the same absolute path as ZIP builds.
POST
/
builds
/
docker-image
Register a Docker image build
curl --request POST \
--url https://api.simpl.gg/v1/builds/docker-image \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"name": "1.2.3",
"image_url": "registry.example.com/game/server:1.2.3"
}
'import requests
url = "https://api.simpl.gg/v1/builds/docker-image"
payload = {
"name": "1.2.3",
"image_url": "registry.example.com/game/server:1.2.3"
}
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({name: '1.2.3', image_url: 'registry.example.com/game/server:1.2.3'})
};
fetch('https://api.simpl.gg/v1/builds/docker-image', 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/docker-image",
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([
'name' => '1.2.3',
'image_url' => 'registry.example.com/game/server:1.2.3'
]),
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.simpl.gg/v1/builds/docker-image"
payload := strings.NewReader("{\n \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\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.simpl.gg/v1/builds/docker-image")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simpl.gg/v1/builds/docker-image")
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 \"name\": \"1.2.3\",\n \"image_url\": \"registry.example.com/game/server:1.2.3\"\n}"
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"
}Authorizations
server_keybearer_auth
Per-project server key, prefixed sk_live_. Full access to every
endpoint. Keep it on your backend: never ship it in a game binary.
Query Parameters
Which project to act on. Required when authenticating with a developer
session (bearer_auth), which names no project of its own; ignored when
authenticating with an API key, which carries its project already.
A project belonging to another account returns PROJECT_NOT_FOUND (7001)
rather than a 403, so this cannot be used to probe for project ids.
Example:
"proj_abc123"
Body
application/json
Register an existing Docker image as a build.
Response
Build registered and processing.
Example:
"build_9f2c"
Build name. Servers reference this as version_tag.
Example:
"1.2.3"
Monotonic integer version assigned per build name.
Example:
12
Available options:
uploading, processing, ready, failed, deleted Available options:
zip, docker_image Path to the server executable inside the ZIP. zip builds only.
Example:
"Linux/GameServer.sh"
Docker image reference. docker_image builds only.
Example:
"registry.example.com/game/server:1.2.3"
Why the build failed, when status is failed. Null otherwise.
A summary, not a log: the full output is at
GET /v1/builds/{build_id}/logs. It is here so that a client
rendering a list of builds can say what went wrong without a second
call per failed row.
Example:
"No executable found at Linux/GameServer.sh"