Skip to main content
PUT
/
v0
/
blueprints
Update a blueprint
curl --request PUT \
  --url https://controller.platform.simplecloud.app/v0/blueprints \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '
{
  "configurator": "example-configurator",
  "minecraft_version": "1.20.1",
  "name": "example-blueprint",
  "runtime_config": {
    "type": "java",
    "with": {}
  },
  "server_software": "paper",
  "server_url": "https://example.com/server",
  "software_version": "1.20.1",
  "workflow_steps": [
    "<string>"
  ]
}
'
import requests

url = "https://controller.platform.simplecloud.app/v0/blueprints"

payload = {
"configurator": "example-configurator",
"minecraft_version": "1.20.1",
"name": "example-blueprint",
"runtime_config": {
"type": "java",
"with": {}
},
"server_software": "paper",
"server_url": "https://example.com/server",
"software_version": "1.20.1",
"workflow_steps": ["<string>"]
}
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {
'X-Network-ID': '<x-network-id>',
'X-Network-Secret': '<x-network-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
configurator: 'example-configurator',
minecraft_version: '1.20.1',
name: 'example-blueprint',
runtime_config: {type: 'java', with: {}},
server_software: 'paper',
server_url: 'https://example.com/server',
software_version: '1.20.1',
workflow_steps: ['<string>']
})
};

fetch('https://controller.platform.simplecloud.app/v0/blueprints', 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://controller.platform.simplecloud.app/v0/blueprints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'configurator' => 'example-configurator',
'minecraft_version' => '1.20.1',
'name' => 'example-blueprint',
'runtime_config' => [
'type' => 'java',
'with' => [

]
],
'server_software' => 'paper',
'server_url' => 'https://example.com/server',
'software_version' => '1.20.1',
'workflow_steps' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Network-ID: <x-network-id>",
"X-Network-Secret: <x-network-secret>"
],
]);

$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://controller.platform.simplecloud.app/v0/blueprints"

payload := strings.NewReader("{\n \"configurator\": \"example-configurator\",\n \"minecraft_version\": \"1.20.1\",\n \"name\": \"example-blueprint\",\n \"runtime_config\": {\n \"type\": \"java\",\n \"with\": {}\n },\n \"server_software\": \"paper\",\n \"server_url\": \"https://example.com/server\",\n \"software_version\": \"1.20.1\",\n \"workflow_steps\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-Network-ID", "<x-network-id>")
req.Header.Add("X-Network-Secret", "<x-network-secret>")
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.put("https://controller.platform.simplecloud.app/v0/blueprints")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.header("Content-Type", "application/json")
.body("{\n \"configurator\": \"example-configurator\",\n \"minecraft_version\": \"1.20.1\",\n \"name\": \"example-blueprint\",\n \"runtime_config\": {\n \"type\": \"java\",\n \"with\": {}\n },\n \"server_software\": \"paper\",\n \"server_url\": \"https://example.com/server\",\n \"software_version\": \"1.20.1\",\n \"workflow_steps\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://controller.platform.simplecloud.app/v0/blueprints")

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

request = Net::HTTP::Put.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"configurator\": \"example-configurator\",\n \"minecraft_version\": \"1.20.1\",\n \"name\": \"example-blueprint\",\n \"runtime_config\": {\n \"type\": \"java\",\n \"with\": {}\n },\n \"server_software\": \"paper\",\n \"server_url\": \"https://example.com/server\",\n \"software_version\": \"1.20.1\",\n \"workflow_steps\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "blueprint_id": "123e4567-e89b-12d3-a456-426614174000",
  "configurator": "example-configurator",
  "created_at": "2023-01-01T12:00:00Z",
  "minecraft_version": "1.20.1",
  "name": "example-blueprint",
  "runtime_config": {
    "type": "java",
    "with": {}
  },
  "server_software": "paper",
  "server_url": "https://example.com/server",
  "software_version": "1.20.1",
  "updated_at": "2023-01-01T12:00:00Z",
  "workflow_steps": [
    "<string>"
  ]
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>"
}

Headers

X-Network-ID
string
required

Network ID

X-Network-Secret
string
required

Network Secret

Query Parameters

blueprint_id
string
required

Blueprint ID

Body

application/json

Blueprint details

Request to update an existing blueprint

configurator
string
Example:

"example-configurator"

minecraft_version
string
Example:

"1.20.1"

name
string
Example:

"example-blueprint"

runtime_config
object

Configuration for the runtime environment

server_software
string
Example:

"paper"

server_url
string
Example:

"https://example.com/server"

software_version
string
Example:

"1.20.1"

workflow_steps
string[]

Response

OK

Response for updating a blueprint

blueprint_id
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

configurator
string
Example:

"example-configurator"

created_at
string
Example:

"2023-01-01T12:00:00Z"

minecraft_version
string
Example:

"1.20.1"

name
string
Example:

"example-blueprint"

runtime_config
object

Configuration for the runtime environment

server_software
string
Example:

"paper"

server_url
string
Example:

"https://example.com/server"

software_version
string
Example:

"1.20.1"

updated_at
string
Example:

"2023-01-01T12:00:00Z"

workflow_steps
string[]