Skip to main content
POST
/
v0
/
persistent-servers
/
workflows
/
manual
Execute a manual workflow for all running servers of a persistent server
curl --request POST \
  --url https://controller.platform.simplecloud.app/v0/persistent-servers/workflows/manual \
  --header 'Content-Type: application/json' \
  --header 'X-Network-ID: <x-network-id>' \
  --header 'X-Network-Secret: <x-network-secret>' \
  --data '
{
  "workflow_id": "internal.cleanup"
}
'
import requests

url = "https://controller.platform.simplecloud.app/v0/persistent-servers/workflows/manual"

payload = { "workflow_id": "internal.cleanup" }
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'X-Network-ID': '<x-network-id>',
'X-Network-Secret': '<x-network-secret>',
'Content-Type': 'application/json'
},
body: JSON.stringify({workflow_id: 'internal.cleanup'})
};

fetch('https://controller.platform.simplecloud.app/v0/persistent-servers/workflows/manual', 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/persistent-servers/workflows/manual",
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([
'workflow_id' => 'internal.cleanup'
]),
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/persistent-servers/workflows/manual"

payload := strings.NewReader("{\n \"workflow_id\": \"internal.cleanup\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://controller.platform.simplecloud.app/v0/persistent-servers/workflows/manual")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"internal.cleanup\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://controller.platform.simplecloud.app/v0/persistent-servers/workflows/manual")

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

request = Net::HTTP::Post.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"internal.cleanup\"\n}"

response = http.request(request)
puts response.read_body
{
  "failed_servers": [
    {
      "error_message": "workflow execution was rejected by serverhost",
      "server_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "message": "Manual workflow execution completed",
  "persistent_server_id": "123e4567-e89b-12d3-a456-426614174000",
  "skipped_server_ids": [
    "<string>"
  ],
  "succeeded_server_ids": [
    "<string>"
  ],
  "total_servers": 1,
  "workflow_id": "internal.cleanup"
}
{
"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

persistent_server_id
string
required

Persistent Server ID

Body

application/json

Manual workflow execution request

Request to execute a manual workflow.

workflow_id
string
Example:

"internal.cleanup"

Response

OK

Response for executing a manual workflow on all eligible servers of a persistent server.

failed_servers
object[]
message
string
Example:

"Manual workflow execution completed"

persistent_server_id
string
Example:

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

skipped_server_ids
string[]
succeeded_server_ids
string[]
total_servers
integer
Example:

1

workflow_id
string
Example:

"internal.cleanup"