Skip to main content
PATCH
/
v0
/
blueprints
Partially update a blueprint
curl --request PATCH \
  --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 '{}'
{
  "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>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://new-docs.simplecloud.app/llms.txt

Use this file to discover all available pages before exploring further.

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 fields to update

The body is of type object.

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[]