From 9034fa89ada895966c55354147ab70ae759e2dd5 Mon Sep 17 00:00:00 2001
From: GitHub Actions <actions@github.com>
Date: Sun, 29 Sep 2024 07:01:45 +0000
Subject: [PATCH] Update - /preview

---
 preview/index.html                 | 4 ++--
 preview/satisfactory-api-spec.json | 2 +-
 preview/satisfactory-api-spec.yaml | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/preview/index.html b/preview/index.html
index 098caf1..34dd90a 100644
--- a/preview/index.html
+++ b/preview/index.html
@@ -398,7 +398,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Satisfactory Game Server HTTPS API specification<!-- --> <span>(<!-- -->0.2.1-preview-11<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><div class="sc-kBAPdo gmEXff"><div class="sc-ftmehX eeVPfW"> <!-- --> <span class="sc-gbwXoZ bcPxPq">License:<!-- --> <a href="https://opensource.org/licenses/MIT">MIT</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;Satisfactory Game Server HTTPS API specification&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Satisfactory Game Server HTTPS API specification<!-- --> <span>(<!-- -->0.1.1-preview-29<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><div class="sc-kBAPdo gmEXff"><div class="sc-ftmehX eeVPfW"> <!-- --> <span class="sc-gbwXoZ bcPxPq">License:<!-- --> <a href="https://opensource.org/licenses/MIT">MIT</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;Satisfactory Game Server HTTPS API specification&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Satisfactory Game Server HTTPS API specification</p>
 </div></div></div></div><div id="operation/HealthCheck" data-section-id="operation/HealthCheck" class="sc-dntaoT aYCdu"><div data-section-id="operation/HealthCheck" id="operation/HealthCheck" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#operation/HealthCheck" aria-label="operation/HealthCheck"></a>Health Check<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="&lt;p&gt;Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. This function requires no Authentication.&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. This function requires no Authentication.</p>
@@ -742,7 +742,7 @@
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Forbidden</p>
 </div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY cpnVKx http-verb post">post</span><span class="sc-etPtWW iqHzp">/api/v1/?function=DownloadSaveGame</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://localhost:7777</span>/api/v1/?function=DownloadSaveGame</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R4ksa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ksa:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ksa:0" aria-labelledby="tab:R4ksa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"function"</span>: <span class="token string">&quot;DownloadSaveGame&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"data"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"saveName"</span>: <span class="token string">&quot;Test Save 1&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R4ssa:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R4ssa:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:R4ssa:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ssa:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:R4ssa:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ssa:2" data-rttab="true">401</li><li class="tab-error" role="tab" id="tab:R4ssa:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R4ssa:3" data-rttab="true">403</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R4ssa:0" aria-labelledby="tab:R4ssa:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"errorCode"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorMessage"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"errorData"</span>: <span class="token punctuation">{ }</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ssa:1" aria-labelledby="tab:R4ssa:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ssa:2" aria-labelledby="tab:R4ssa:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R4ssa:3" aria-labelledby="tab:R4ssa:3"></div></div></div></div></div></div></div><div class="sc-eEVuZf ifLiBE"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"Satisfactory Game Server HTTPS API specification","description":"Satisfactory Game Server HTTPS API specification","version":"0.2.1-preview-11","license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"}},"servers":[{"url":"https://localhost:7777"}],"paths":{"/api/v1/?function=HealthCheck":{"post":{"summary":"Health Check","operationId":"HealthCheck","description":"Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. This function requires no Authentication.","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthCheckRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthCheckResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=VerifyAuthenticationToken":{"post":{"summary":"Verify Authentication Token","operationId":"VerifyAuthenticationToken","description":"Verifies the Authentication token provided to the Dedicated Server API. Returns No Content if the provided token is valid. This function does not require input parameters and does not return any data.","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verifyAuthenticationTokenRequest"}}},"required":true},"responses":{"204":{"description":"No Content - Authentication token is still valid"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=PasswordlessLogin":{"post":{"summary":"Passwordless Login","operationId":"PasswordlessLogin","description":"Attempts to perform a passwordless login to the Dedicated Server as a player. Passwordless login is possible if the Dedicated Server is not claimed, or if Client Protection Password is not set for the Dedicated Server. This function requires no Authentication.\n","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordlessLoginRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordlessLoginResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=PasswordLogin":{"post":{"summary":"Password Login","operationId":"PasswordLogin","description":"Attempts to log in to the Dedicated Server as a player using either Admin Password or Client Protection Password. This function requires no Authentication.\n","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordLoginRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordLoginResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=QueryServerState":{"post":{"summary":"Query Server State","operationId":"QueryServerState","description":"Retrieves the current state of the Dedicated Server. Does not require any input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queryServerStateRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queryServerStateResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=GetServerOptions":{"post":{"summary":"Get Server Options","operationId":"GetServerOptions","description":"Retrieves currently applied server options and server options that are still pending application (because of needing session or server restart) Does not require input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/getServerOptionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getServerOptionsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=GetAdvancedGameSettings":{"post":{"summary":"Get Advanced Game Settings","operationId":"GetAdvancedGameSettings","description":"Retrieves currently applied advanced game settings. Does not require input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/getAdvancedGameSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getAdvancedGameSettingsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ApplyAdvancedGameSettings":{"post":{"summary":"Apply Advanced Game Settings","operationId":"ApplyAdvancedGameSettings","description":"Applies new values to the provided Advanced Game Settings properties. Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applyAdvancedGameSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ClaimServer":{"post":{"summary":"Claim Server","operationId":"ClaimServer","description":"Claims this Dedicated Server if it is not claimed. Requires InitialAdmin privilege level, which can only be acquired by attempting passwordless login while the server does not have an Admin Password set, e.g. it is not claimed yet. Function does not return any data in case of success, and the server is claimed. The client should drop InitialAdmin privileges after that and use returned AuthenticationToken instead, and update it's cached server game state by calling QueryServerState.\n","security":[{"bearerAuth":["InitialAdmin"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimServerRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimServerResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=RenameServer":{"post":{"summary":"Rename Server","operationId":"RenameServer","description":"Renames the Dedicated Server once it has been claimed. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/renameServerRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetClientPassword":{"post":{"summary":"Set Client Password","operationId":"SetClientPassword","description":"Updates the currently set Client Protection Password. This will invalidate all previously issued Client authentication tokens. Pass empty string to remove the password, and let anyone join the server as Client. Requres Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setClientPasswordRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetAdminPassword":{"post":{"summary":"Set Admin Password","operationId":"SetAdminPassword","description":"Updates the currently set Admin Password. This will invalidate all previously issued Client and Admin authentication tokens. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAdminPasswordRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAdminPasswordResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetAutoLoadSessionName":{"post":{"summary":"Set Auto Load Session Name","operationId":"SetAutoLoadSessionName","description":"Updates the name of the session that the Dedicated Server will automatically load on startup. Does not change currently loaded session. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAutoLoadSessionNameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=RunCommand":{"post":{"summary":"Run Command","operationId":"RunCommand","description":"Runs the given Console Command on the Dedicated Server, and returns it's output to the Console. Requires Admin privileges.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/runCommandRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=Shutdown":{"post":{"summary":"Shutdown","operationId":"Shutdown","description":"Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shutdownRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ApplyServerOptions":{"post":{"summary":"Apply Server Options","operationId":"ApplyServerOptions","description":"Applies new Server Options to the Dedicated Server. Requires Admin privileges.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applyServerOptionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=CreateNewGame":{"post":{"summary":"Create New Game","operationId":"CreateNewGame","description":"Creates a new session on the Dedicated Server, and immediately loads it. HTTPS API becomes temporarily unavailable when map loading is in progress | Function does not return any data on success.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createNewGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"202":{"description":"Accepted - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SaveGame":{"post":{"summary":"Save Game","operationId":"SaveGame","description":"Saves the currently loaded session into the new save game file named as the argument. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/saveGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DeleteSaveFile":{"post":{"summary":"Delete Save File","operationId":"DeleteSaveFile","description":"Deletes the existing save game file from the server. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteSaveFileRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DeleteSaveSession":{"post":{"summary":"Delete Save Session","operationId":"DeleteSaveSession","description":"Deletes all save files belonging to the specific session name. Requires Admin privileges. SessionName must be a valid session name with at least one saved save game file belonging to it. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteSaveSessionRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=EnumerateSessions":{"post":{"summary":"Enumerate Sessions","operationId":"EnumerateSessions","description":"Enumerates all save game files available on the Dedicated Server. Requires Admin privileges. Function does not require any additional parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enumerateSessionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enumerateSessionsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=LoadGame":{"post":{"summary":"Load Game","operationId":"LoadGame","description":"Loads the save game file by name, optionally with Advanced Game Settings enabled. Requires Admin privileges. Dedicated Server HTTPS API will become temporarily unavailable when save game is being loaded. Function does not return any data on succcess.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loadGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=UploadSaveGame":{"post":{"summary":"Upload Save Game","operationId":"UploadSaveGame","description":"Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/uploadSaveGameRequest"},"encoding":{"function":{"contentType":"application/json"},"data":{"contentType":"application/json"},"saveGameFile":{"contentType":"application/octet-stream"}}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DownloadSaveGame":{"post":{"summary":"Download Save Game","operationId":"DownloadSaveGame","description":"Downloads save game with the given name from the Dedicated Server. Requires Admin privileges. This function responds with the file attachment containing the save game file on success, and with normal error response in case of error.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloadSaveGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"healthCheckRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"HealthCheck","default":"HealthCheck","example":"HealthCheck"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"clientCustomData":{"type":"string","description":"Custom Data passed from the Game Client or Third Party service. Not used by vanilla Dedicated Servers"}},"required":["clientCustomData"]}},"required":["function","data"]},"error":{"type":"object","title":"error","properties":{"errorCode":{"type":"string","description":"Machine-friendly code indicating the type of the error that the executed function returned"},"errorMessage":{"type":"string","description":"Optional. Human-friendly error message explaining the error"},"errorData":{"type":"object","description":"Optional. Additional information about the error, for example, list of parameters that are missing"}},"required":["errorCode"]},"healthCheckResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","slow"],"description":"healthy if tick rate is above ten ticks per second, slow otherwise"},"serverCustomData":{"type":"string","description":"Custom Data passed from the Dedicated Server to the Game Client or Third Party service. Vanilla Dedicated Server returns empty string"}},"required":["health"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"verifyAuthenticationTokenRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"VerifyAuthenticationToken","default":"VerifyAuthenticationToken","example":"VerifyAuthenticationToken"}},"required":["function"]},"privilegeLevel":{"type":"string","description":"Privilege Level granted of a Authorization/Authentication token.\n- `NotAuthenticated`: The client is not Authenticated\n- `Client`: Client is Authenticated with Client privileges\n- `Administrator`: Client is Authenticated with Admin privileges\n- `InitialAdmin: Client is Authenticated as Initial Admin with privileges to Claim the server\n- `APIToken`: Client is Authenticated as Third Party Application\n","enum":["NotAuthenticated","Client","Administrator","InitialAdmin","APIToken"]},"passwordlessLoginRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"PasswordlessLogin","default":"PasswordlessLogin","example":"PasswordlessLogin"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"minimumPrivilegeLevel":{"$ref":"#/components/schemas/privilegeLevel","description":"Minimum privilege level to attempt to acquire by logging in.","example":"InitialAdmin"}},"required":["minimumPrivilegeLevel"]}},"required":["function","data"]},"passwordlessLoginResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"Authentication Token in case login is successful"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"passwordLoginRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"PasswordLogin","default":"PasswordLogin","example":"PasswordLogin"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"minimumPrivilegeLevel":{"$ref":"#/components/schemas/privilegeLevel","description":"Minimum privilege level to attempt to acquire by logging in.","example":"Administator"},"password":{"type":"string","description":"Password to attempt to log in with, in plaintext","example":"super-secret-password"}},"required":["minimumPrivilegeLevel","password"]}},"required":["function","data"]},"passwordLoginResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"Authentication Token in case login is successful"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"queryServerStateRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"QueryServerState","default":"QueryServerState","example":"QueryServerState"}},"required":["function"]},"queryServerStateResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"serverGameState":{"type":"object","description":"Current game state of the server","properties":{"activeSessionName":{"type":"string","description":"Name of the currently loaded game session","example":"SERVER-SESSION26924571"},"numConnectedPlayers":{"type":"integer","description":"Number of the players currently connected to the Dedicated Server","example":0},"playerLimit":{"type":"integer","description":"Maximum number of players that can be connected to the Dedicated Server","example":4},"techTier":{"type":"integer","description":"Maximum Tech Tier of all Schematics currently unlocked","example":0},"activeSchematic":{"type":"string","description":"Schematic currently set as Active Milestone","example":"None"},"gamePhase":{"type":"string","description":"Current game phase. None if no game is running","example":"None"},"isGameRunning":{"type":"boolean","description":"True if the save is currently loaded, false if the server is waiting for the session to be created","example":false},"totalGameDuration":{"type":"integer","description":"Total time the current save has been loaded, in seconds","example":0},"isGamePaused":{"type":"boolean","description":"True if the game is paused. If the game is paused, total game duration does not increase","example":false},"averageTickRate":{"type":"number","description":"Average tick rate of the server, in ticks per second","format":"float","example":29.89044189453125},"autoLoadSessionName":{"type":"string","description":"Name of the session that will be loaded when the server starts automatically","example":"SERVER-SESSION26924571"}},"required":["activeSessionName","numConnectedPlayers","playerLimit","techTier","activeSchematic","gamePhase","isGameRunning","totalGameDuration","isGamePaused","averageTickRate","autoLoadSessionName"]}},"required":["serverGameState"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"getServerOptionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"GetServerOptions","default":"GetServerOptions","example":"GetServerOptions"}},"required":["function"]},"serverOptions":{"type":"object","description":"All current server option values, where keys are the option names and values are their stringified values.","additionalProperties":{"type":"string"},"example":{"FG.DSAutoPause":"True","FG.DSAutoSaveOnDisconnect":"True","FG.DisableSeasonalEvents":"False","FG.AutosaveInterval":"300.0","FG.ServerRestartTimeSlot":"1440.0","FG.SendGameplayData":"True","FG.NetworkQuality":"1"}},"getServerOptionsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"serverOptions":{"$ref":"#/components/schemas/serverOptions"},"pendingServerOptions":{"description":"Server option values that will be applied when the session or server restarts, where keys are the option names and values are their stringified values.","$ref":"#/components/schemas/serverOptions"}},"required":["serverOptions","pendingServerOptions"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"getAdvancedGameSettingsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"GetAdvancedGameSettings","default":"GetAdvancedGameSettings","example":"GetAdvancedGameSettings"}},"required":["function"]},"advancedGameSettings":{"type":"object","properties":{"creativeModeEnabled":{"type":"boolean","description":"True if Advanced Game Settings are enabled for the currently loaded session","example":false},"advancedGameSettings":{"type":"object","description":"Values of Advanced Game Settings. Key is the name of the setting, and value is its stringified value","additionalProperties":{"type":"string"},"example":{"FG.GameRules.NoPower":"False","FG.GameRules.StartingTier":"0","FG.GameRules.DisableArachnidCreatures":"False","FG.GameRules.NoUnlockCost":"False","FG.GameRules.SetGamePhase":"0","FG.GameRules.UnlockAllResearchSchematics":"False","FG.GameRules.UnlockInstantAltRecipes":"False","FG.GameRules.UnlockAllResourceSinkSchematics":"False","FG.PlayerRules.NoBuildCost":"False","FG.PlayerRules.GodMode":"False","FG.PlayerRules.FlightMode":"False"}}},"required":["creativeModeEnabled","advancedGameSettings"]},"getAdvancedGameSettingsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","$ref":"#/components/schemas/advancedGameSettings"}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"applyAdvancedGameSettingsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ApplyAdvancedGameSettings","default":"ApplyAdvancedGameSettings","example":"ApplyAdvancedGameSettings"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","$ref":"#/components/schemas/advancedGameSettings"}},"required":["function","data"]},"claimServerRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ClaimServer","default":"ClaimServer","example":"ClaimServer"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"serverName":{"type":"string","description":"New name of the Dedicated Server","example":"Test Server"},"adminPassword":{"type":"string","description":"Admin Password to set on the Dedicated Server, in plaintext","example":"super-secret-password"}},"required":["serverName","adminPassword"]}},"required":["function","data"]},"claimServerResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"New Authentication Token that the Caller should use to drop Initial Admin privileges"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"renameServerRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"RenameServer","default":"RenameServer","example":"RenameServer"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"serverName":{"type":"string","description":"New name of the Dedicated Server","example":"Not Test Server"}},"required":["serverName"]}},"required":["function","data"]},"setClientPasswordRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetClientPassword","default":"SetClientPassword","example":"SetClientPassword"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"password":{"type":"string","description":"Client Password to set on the Dedicated Server, in plaintext","example":"password-used-to-play-on-the-server"}},"required":["password"]}},"required":["function","data"]},"setAdminPasswordRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetAdminPassword","default":"SetAdminPassword","example":"SetAdminPassword"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"password":{"type":"string","description":"Admin Password to set on the Dedicated Server, in plaintext","example":"super-secret-password"}},"required":["password"]}},"required":["function","data"]},"setAdminPasswordResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"New Admin authentication token to use, since the token used for this request will become invalidated"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"setAutoLoadSessionNameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetAutoLoadSessionName","default":"SetAutoLoadSessionName","example":"SetAutoLoadSessionName"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"sessionName":{"type":"string","description":"Name of the session to automatically load on Dedicated Server startup","example":"Test"}},"required":["sessionName"]}},"required":["function","data"]},"runCommandRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"RunCommand","default":"RunCommand","example":"RunCommand"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"command":{"type":"string","description":"Command Line to run on the Dedicated Server"}},"required":["command"]}},"required":["function","data"]},"shutdownRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"Shutdown","default":"Shutdown","example":"Shutdown"}},"required":["function"]},"applyServerOptionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ApplyServerOptions","default":"ApplyServerOptions","example":"ApplyServerOptions"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"updatedServerOptions":{"description":"Key is the name of the Server Option, and the Value is the new value as string","$ref":"#/components/schemas/serverOptions"}},"required":["updatedServerOptions"]}},"required":["function","data"]},"createNewGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"CreateNewGame","default":"CreateNewGame","example":"CreateNewGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"newGameData":{"type":"object","description":"Key is the name of the Server Option, and the Value is the new value as string","properties":{"sessionName":{"type":"string","description":"Name of the session to create","example":"Test"},"mapName":{"type":"string","description":"Path Name to the Map Package to use as a map. If not specified, default level","example":""},"startingLocation":{"type":"string","description":"Name of the starting location to use. Leaving it empty will use random starting location","example":""},"bSkipOnboarding":{"type":"boolean","example":false,"description":"Whether the Onboarding should be skipped. Currently, Onboarding is always skipped on the Dedicated Servers. Currently SkipOnboarding must be set to bSkipOnboarding, due to an issue with the property names."},"advancedGameSettings":{"description":"Advanced Game Settings to apply to the newly created session","$ref":"#/components/schemas/advancedGameSettings"},"customOptionsOnlyForModding":{"type":"object","description":"Custom Options to pass to the newly created session URL. Not used by vanilla Dedicated Servers","additionalProperties":{"type":"string"},"example":{}}},"required":["sessionName","mapName","startingLocation","bSkipOnboarding"]}},"required":["newGameData"]}},"required":["function","data"]},"saveGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SaveGame","default":"SaveGame","example":"SaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to create. Passed name might be sanitized","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]},"deleteSaveFileRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DeleteSaveFile","default":"DeleteSaveFile","example":"DeleteSaveFile"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to delete. Passed name might be sanitized","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]},"deleteSaveSessionRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DeleteSaveSession","default":"DeleteSaveSession","example":"DeleteSaveSession"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"sessionName":{"type":"string","description":"Name of the save session to delete","example":"Test"}},"required":["sessionName"]}},"required":["function","data"]},"enumerateSessionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"EnumerateSessions","default":"EnumerateSessions","example":"EnumerateSessions"}},"required":["function"]},"saveHeader":{"type":"object","properties":{"saveVersion":{"type":"integer","description":"Version of the Save Game format this file was saved with","example":46},"buildVersion":{"type":"integer","description":"Changelist of the game or dedicated server this file was saved by","example":368883},"saveName":{"type":"string","description":"Name of the save game file in the filesystem","example":"Test_autosave_0"},"saveLocationInfo":{"type":"string","description":"Unknown - Not listed in official documentation","example":"SLI_Server"},"mapName":{"type":"string","description":"Path to the map package this save game file is based on","example":"Persistent_Level"},"mapOptions":{"type":"string","description":"Additional Map URL options this save game was saved with","example":"?skiponboarding"},"sessionName":{"type":"string","description":"Name of the session this save game file belongs to","example":"Test"},"playDurationSeconds":{"type":"integer","description":"Amount of seconds the game has been running for in total since the session was created","example":30},"saveDateTime":{"type":"string","description":"Date and time on which the save game file was saved","example":"2024.09.28-04.00.32"},"isModdedSave":{"type":"boolean","description":"True if this save game file was saved with mods","example":false},"isEditedSave":{"type":"boolean","description":"True if this save game file has been edited by third party tools","example":false},"isCreativeModeEnabled":{"type":"boolean","description":"True if Advanced Game Settings are enabled for this save game","example":false}},"required":["saveVersion","buildVersion","saveName","mapName","mapOptions","sessionName","playDurationSeconds","saveDateTime","isModdedSave","isEditedSave","isCreativeModeEnabled"]},"sessionSaveStruct":{"type":"object","properties":{"sessionName":{"type":"string","description":"Name of the save session","example":"Test"},"saveHeaders":{"type":"array","description":"All save game files belonging to this session","items":{"$ref":"#/components/schemas/saveHeader"}}},"required":["sessionName","saveHeaders"]},"enumerateSessionsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"sessions":{"type":"array","description":"List of sessions available on the Dedicated Server","items":{"$ref":"#/components/schemas/sessionSaveStruct"}},"currentSessionIndex":{"type":"integer","description":"Index of the currently selected session in the list","example":0}},"required":["sessions","currentSessionIndex"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"loadGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"LoadGame","default":"LoadGame","example":"LoadGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to load","example":"Test Save 1"},"enableAdvancedGameSettings":{"type":"boolean","description":"True if save game file should be loaded with Advanced Game Settings enabled","example":false}},"required":["saveName","enableAdvancedGameSettings"]}},"required":["function","data"]},"uploadSaveGameRequest":{"type":"object","properties":{"data":{"type":"object","description":"Standard Request Data body for this request, encoded as UTF-8 JSON. Note that this includes the envelope.","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"UploadSaveGame","default":"UploadSaveGame","example":"UploadSaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to create on the Dedicated Server.","example":"Uploaded Save"},"loadSaveGame":{"type":"boolean","description":"True if the save game file should be immediately loaded by the Dedicated Server.","example":true},"enableAdvancedGameSettings":{"type":"boolean","description":"True if the save game file should be loaded with Advanced Game Settings enabled.","example":false}},"required":["saveName","loadSaveGame","enableAdvancedGameSettings"]}},"required":["function","data"]},"saveGameFile":{"type":"string","format":"binary","description":"File attachment containing the save game file. Contents of the file will be validated on the server."}},"required":["data","saveGameFile"]},"downloadSaveGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DownloadSaveGame","default":"DownloadSaveGame","example":"DownloadSaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to download from the Dedicated Server","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]}},"responses":{"error":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}}},"searchIndex":{"store":["operation/HealthCheck","operation/VerifyAuthenticationToken","operation/PasswordlessLogin","operation/PasswordLogin","operation/QueryServerState","operation/GetServerOptions","operation/GetAdvancedGameSettings","operation/ApplyAdvancedGameSettings","operation/ClaimServer","operation/RenameServer","operation/SetClientPassword","operation/SetAdminPassword","operation/SetAutoLoadSessionName","operation/RunCommand","operation/Shutdown","operation/ApplyServerOptions","operation/CreateNewGame","operation/SaveGame","operation/DeleteSaveFile","operation/DeleteSaveSession","operation/EnumerateSessions","operation/LoadGame","operation/UploadSaveGame","operation/DownloadSaveGame"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.551,1,2.551]],["description/0",[0,2.312,1,2.312,2,2.312,3,0.573,4,0.028,5,1.722,6,1.974,7,2.312,8,2.312,9,0.547,10,2.825,11,3.879,12,0.358,13,1.209,14,0.302,15,0.151,16,1.209,17,2.825]],["title/1",[16,1.137,18,2.175,19,1.273]],["description/1",[3,0.434,4,0.021,5,1.791,9,0.569,14,0.315,15,0.158,16,1.258,18,2.405,19,1.908,20,3.262,21,0.772,22,2.939,23,2.405,24,1.791,25,1.258,26,2.939]],["title/2",[27,2.178,28,1.9]],["description/2",[2,2.226,3,0.641,4,0.031,13,1.164,14,0.291,15,0.146,16,1.164,27,2.641,28,2.303,29,1.9,30,2.226,31,2.719,32,1.658,33,1.9,34,1.043,35,0.527,36,2.719]],["title/3",[28,1.9,34,1.195]],["description/3",[3,0.472,4,0.023,13,1.368,14,0.342,15,0.171,16,1.368,29,2.234,30,2.616,33,2.234,34,1.616,37,2.234,38,2.616,39,0.405,40,3.196]],["title/4",[4,0.019,41,2.658,42,1.858]],["description/4",[3,0.544,4,0.026,15,0.197,24,2.243,25,1.575,42,2.572,43,2.572,44,1.411,45,3.68]],["title/5",[4,0.022,46,1.678]],["description/5",[4,0.033,15,0.161,24,1.828,25,1.283,43,2.096,44,1.15,46,2.174,47,1.15,48,2.999,49,2.999,50,2.999,51,2.999,52,1.15,53,2.096,54,2.999]],["title/6",[12,0.337,35,0.515,55,1.431]],["description/6",[12,0.455,15,0.192,24,2.188,25,1.536,35,0.695,43,2.508,44,1.376,47,1.376,55,1.932,56,3.589]],["title/7",[12,0.294,35,0.449,47,0.888,55,1.247]],["description/7",[12,0.505,20,2.405,35,0.772,44,1.127,47,1.127,55,2.145,57,1.258,58,2.939,59,2.939,60,1.791,61,3.262,62,1.258,63,0.724,64,2.939,65,2.939]],["title/8",[4,0.022,32,1.9]],["description/8",[3,0.297,4,0.029,9,0.389,12,0.255,13,0.859,14,0.215,15,0.108,21,0.587,27,1.403,28,1.224,29,1.403,32,2.481,34,0.77,35,0.389,38,1.643,39,0.255,42,1.403,66,3.032,67,0.515,68,2.008,69,2.008,70,2.008,71,1.643,72,0.495,73,2.008,74,2.008,75,2.008,76,0.961,77,1.643,78,2.008,79,2.008,80,2.008,81,2.008]],["title/9",[4,0.022,82,2.551]],["description/9",[3,0.494,4,0.024,9,0.647,14,0.358,15,0.179,21,0.647,32,2.037,39,0.424,67,0.568,72,0.824,82,2.736,83,3.343,84,3.343]],["title/10",[13,1.137,34,1.019,35,0.515]],["description/10",[4,0.018,7,2.002,9,0.474,13,1.754,14,0.262,16,1.047,19,1.171,21,0.474,33,1.709,34,1.344,35,0.474,39,0.31,44,0.938,67,0.416,72,0.603,76,1.171,85,2.002,86,2.002,87,2.002,88,2.446,89,2.446,90,2.446,91,2.446,92,2.446,93,2.446,94,2.446]],["title/11",[34,1.019,35,0.515,39,0.337]],["description/11",[9,0.558,13,1.233,14,0.308,15,0.154,16,1.233,19,1.379,21,0.558,34,1.105,35,0.558,39,0.567,44,1.105,67,0.489,72,0.71,76,1.379,85,2.358,86,2.358,87,2.358,95,2.881]],["title/12",[35,0.398,52,0.787,62,0.879,96,2.053,97,0.879]],["description/12",[3,0.425,4,0.021,9,0.558,14,0.308,15,0.154,21,0.558,39,0.365,44,1.105,52,1.508,60,1.756,62,1.682,67,0.489,72,0.71,76,1.379,97,1.233,98,2.881,99,2.013,100,2.881]],["title/13",[101,2.551,102,2.551]],["description/13",[3,0.483,4,0.023,15,0.175,21,0.633,39,0.414,67,0.555,77,2.674,101,2.674,102,2.674,103,2.674,104,4.277,105,3.268,106,3.268]],["title/14",[107,2.633]],["description/14",[3,0.344,4,0.024,6,1.627,9,0.451,14,0.249,15,0.125,19,1.115,21,0.451,25,0.997,35,0.451,37,1.627,39,0.295,47,0.893,53,2.365,57,0.997,60,1.419,67,0.396,72,0.574,76,1.115,107,1.627,108,1.906,109,1.906,110,1.906,111,1.906,112,1.906,113,1.906,114,1.906,115,1.906,116,1.906,117,2.329]],["title/15",[4,0.019,46,1.431,47,1.019]],["description/15",[3,0.53,4,0.033,15,0.192,39,0.455,46,1.932,47,1.376,57,1.536,67,0.61,118,3.589]],["title/16",[12,0.337,57,1.137,119,2.175]],["description/16",[3,0.417,4,0.02,5,1.722,9,0.547,14,0.302,21,0.547,52,1.083,57,1.209,62,1.66,72,0.696,119,2.312,120,2.825,121,2.312,122,2.312,123,2.312,124,2.312,125,2.825,126,2.825,127,2.825,128,2.825]],["title/17",[12,0.395,63,0.768]],["description/17",[9,0.499,12,0.326,14,0.276,15,0.138,21,0.499,39,0.326,44,0.988,52,0.988,57,1.102,62,1.102,63,0.896,67,0.438,72,0.635,97,1.557,99,1.8,129,1.805,130,2.575,131,2.108,132,2.108,133,2.108,134,2.108,135,2.575]],["title/18",[63,0.655,129,1.137,136,1.62]],["description/18",[4,0.02,9,0.537,12,0.351,14,0.297,15,0.149,21,0.537,39,0.351,63,0.683,67,0.471,72,0.683,97,1.186,99,1.937,129,1.877,131,2.268,132,2.268,133,2.268,134,2.268,136,1.689,137,2.771,138,2.771]],["title/19",[52,1.019,63,0.655,136,1.62]],["description/19",[9,0.508,12,0.332,14,0.281,15,0.141,21,0.508,23,2.146,39,0.332,52,1.412,63,1.049,67,0.445,72,0.646,97,1.576,129,1.576,136,1.598,139,3.683,140,2.622,141,2.622,142,2.622,143,2.622]],["title/20",[52,1.195,144,2.551]],["description/20",[3,0.472,4,0.023,8,2.616,12,0.405,14,0.342,15,0.226,25,1.368,39,0.405,63,0.787,67,0.543,129,1.368,144,2.616,145,3.196,146,3.196]],["title/21",[12,0.395,62,1.334]],["description/21",[3,0.361,4,0.018,5,1.491,9,0.474,12,0.52,14,0.262,15,0.131,21,0.474,35,0.474,39,0.31,46,1.316,55,1.316,61,2.002,62,1.5,63,0.864,67,0.416,97,1.047,121,2.002,122,2.002,123,2.002,124,2.002,129,1.047,147,2.446,148,2.446,149,2.446]],["title/22",[12,0.337,63,0.655,150,2.658]],["description/22",[3,0.344,4,0.024,6,1.627,9,0.451,14,0.249,15,0.125,19,1.115,21,0.451,25,0.997,35,0.451,37,1.627,39,0.295,47,0.893,53,2.365,57,0.997,60,1.419,67,0.396,72,0.574,76,1.115,107,1.627,108,1.906,109,1.906,110,1.906,111,1.906,112,1.906,113,1.906,114,1.906,115,1.906,116,1.906,151,2.329]],["title/23",[12,0.337,63,0.655,152,2.175]],["description/23",[3,0.387,4,0.019,12,0.467,14,0.281,15,0.141,39,0.332,63,0.907,67,0.445,71,2.146,72,0.646,97,1.122,103,2.146,129,1.576,152,2.146,153,2.622,154,2.622,155,2.622,156,2.622,157,3.683,158,2.622,159,2.622]]],"invertedIndex":[["",{"_index":127,"title":{},"description":{"16":{}}}],["acquir",{"_index":69,"title":{},"description":{"8":{}}}],["addit",{"_index":8,"title":{},"description":{"0":{},"20":{}}}],["admin",{"_index":39,"title":{"11":{}},"description":{"3":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["advanc",{"_index":55,"title":{"6":{},"7":{}},"description":{"6":{},"7":{},"21":{}}}],["allow",{"_index":6,"title":{},"description":{"0":{},"14":{},"22":{}}}],["alreadi",{"_index":64,"title":{},"description":{"7":{}}}],["anyon",{"_index":91,"title":{},"description":{"10":{}}}],["api",{"_index":5,"title":{},"description":{"0":{},"1":{},"16":{},"21":{}}}],["api/v1/?function=applyadvancedgameset",{"_index":65,"title":{},"description":{"7":{}}}],["api/v1/?function=applyserveropt",{"_index":118,"title":{},"description":{"15":{}}}],["api/v1/?function=claimserv",{"_index":81,"title":{},"description":{"8":{}}}],["api/v1/?function=createnewgam",{"_index":128,"title":{},"description":{"16":{}}}],["api/v1/?function=deletesavefil",{"_index":138,"title":{},"description":{"18":{}}}],["api/v1/?function=deletesavesess",{"_index":143,"title":{},"description":{"19":{}}}],["api/v1/?function=downloadsavegam",{"_index":159,"title":{},"description":{"23":{}}}],["api/v1/?function=enumeratesess",{"_index":146,"title":{},"description":{"20":{}}}],["api/v1/?function=getadvancedgameset",{"_index":56,"title":{},"description":{"6":{}}}],["api/v1/?function=getserveropt",{"_index":54,"title":{},"description":{"5":{}}}],["api/v1/?function=healthcheck",{"_index":17,"title":{},"description":{"0":{}}}],["api/v1/?function=loadgam",{"_index":149,"title":{},"description":{"21":{}}}],["api/v1/?function=passwordlesslogin",{"_index":36,"title":{},"description":{"2":{}}}],["api/v1/?function=passwordlogin",{"_index":40,"title":{},"description":{"3":{}}}],["api/v1/?function=queryserverst",{"_index":45,"title":{},"description":{"4":{}}}],["api/v1/?function=renameserv",{"_index":84,"title":{},"description":{"9":{}}}],["api/v1/?function=runcommand",{"_index":106,"title":{},"description":{"13":{}}}],["api/v1/?function=savegam",{"_index":135,"title":{},"description":{"17":{}}}],["api/v1/?function=setadminpassword",{"_index":95,"title":{},"description":{"11":{}}}],["api/v1/?function=setautoloadsessionnam",{"_index":100,"title":{},"description":{"12":{}}}],["api/v1/?function=setclientpassword",{"_index":94,"title":{},"description":{"10":{}}}],["api/v1/?function=shutdown",{"_index":117,"title":{},"description":{"14":{}}}],["api/v1/?function=uploadsavegam",{"_index":151,"title":{},"description":{"22":{}}}],["api/v1/?function=verifyauthenticationtoken",{"_index":26,"title":{},"description":{"1":{}}}],["appli",{"_index":47,"title":{"7":{},"15":{}},"description":{"5":{},"6":{},"7":{},"14":{},"15":{},"22":{}}}],["applic",{"_index":50,"title":{},"description":{"5":{}}}],["argument",{"_index":130,"title":{},"description":{"17":{}}}],["attach",{"_index":154,"title":{},"description":{"23":{}}}],["attempt",{"_index":29,"title":{},"description":{"2":{},"3":{},"8":{}}}],["authent",{"_index":16,"title":{"1":{}},"description":{"0":{},"1":{},"2":{},"3":{},"10":{},"11":{}}}],["authenticationtoken",{"_index":74,"title":{},"description":{"8":{}}}],["auto",{"_index":96,"title":{"12":{}},"description":{}}],["automat",{"_index":60,"title":{},"description":{"7":{},"12":{},"14":{},"22":{}}}],["avail",{"_index":145,"title":{},"description":{"20":{}}}],["be",{"_index":147,"title":{},"description":{"21":{}}}],["becom",{"_index":122,"title":{},"description":{"16":{},"21":{}}}],["belong",{"_index":139,"title":{},"description":{"19":{}}}],["between",{"_index":10,"title":{},"description":{"0":{}}}],["cach",{"_index":78,"title":{},"description":{"8":{}}}],["call",{"_index":79,"title":{},"description":{"8":{}}}],["case",{"_index":71,"title":{},"description":{"8":{},"23":{}}}],["chang",{"_index":99,"title":{},"description":{"12":{},"17":{},"18":{}}}],["check",{"_index":1,"title":{"0":{}},"description":{"0":{}}}],["claim",{"_index":32,"title":{"8":{}},"description":{"2":{},"8":{},"9":{}}}],["client",{"_index":13,"title":{"10":{}},"description":{"0":{},"2":{},"3":{},"8":{},"10":{},"11":{}}}],["command",{"_index":102,"title":{"13":{}},"description":{"13":{}}}],["consol",{"_index":104,"title":{},"description":{"13":{}}}],["contain",{"_index":155,"title":{},"description":{"23":{}}}],["content",{"_index":22,"title":{},"description":{"1":{}}}],["creat",{"_index":119,"title":{"16":{}},"description":{"16":{}}}],["current",{"_index":44,"title":{},"description":{"4":{},"5":{},"6":{},"7":{},"10":{},"11":{},"12":{},"17":{}}}],["data",{"_index":9,"title":{},"description":{"0":{},"1":{},"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["dedic",{"_index":3,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"8":{},"9":{},"12":{},"13":{},"14":{},"15":{},"16":{},"20":{},"21":{},"22":{},"23":{}}}],["delet",{"_index":136,"title":{"18":{},"19":{}},"description":{"18":{},"19":{}}}],["down",{"_index":109,"title":{},"description":{"14":{},"22":{}}}],["download",{"_index":152,"title":{"23":{}},"description":{"23":{}}}],["drop",{"_index":73,"title":{},"description":{"8":{}}}],["e.g",{"_index":70,"title":{},"description":{"8":{}}}],["empti",{"_index":88,"title":{},"description":{"10":{}}}],["enabl",{"_index":61,"title":{},"description":{"7":{},"21":{}}}],["enumer",{"_index":144,"title":{"20":{}},"description":{"20":{}}}],["error",{"_index":157,"title":{},"description":{"23":{}}}],["exist",{"_index":137,"title":{},"description":{"18":{}}}],["file",{"_index":129,"title":{"18":{}},"description":{"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["function",{"_index":14,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["game",{"_index":12,"title":{"6":{},"7":{},"16":{},"17":{},"21":{},"22":{},"23":{}},"description":{"0":{},"6":{},"7":{},"8":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["given",{"_index":103,"title":{},"description":{"13":{},"23":{}}}],["health",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["host",{"_index":114,"title":{},"description":{"14":{},"22":{}}}],["http",{"_index":121,"title":{},"description":{"16":{},"21":{}}}],["immedi",{"_index":120,"title":{},"description":{"16":{}}}],["initi",{"_index":112,"title":{},"description":{"14":{},"22":{}}}],["initialadmin",{"_index":66,"title":{},"description":{"8":{}}}],["input",{"_index":24,"title":{},"description":{"1":{},"4":{},"5":{},"6":{}}}],["instead",{"_index":75,"title":{},"description":{"8":{}}}],["invalid",{"_index":85,"title":{},"description":{"10":{},"11":{}}}],["ip",{"_index":115,"title":{},"description":{"14":{},"22":{}}}],["issu",{"_index":87,"title":{},"description":{"10":{},"11":{}}}],["it'",{"_index":77,"title":{},"description":{"8":{},"13":{}}}],["join",{"_index":92,"title":{},"description":{"10":{}}}],["level",{"_index":68,"title":{},"description":{"8":{}}}],["load",{"_index":62,"title":{"12":{},"21":{}},"description":{"7":{},"12":{},"16":{},"17":{},"21":{}}}],["log",{"_index":37,"title":{},"description":{"3":{},"14":{},"22":{}}}],["login",{"_index":28,"title":{"2":{},"3":{}},"description":{"2":{},"8":{}}}],["map",{"_index":125,"title":{},"description":{"16":{}}}],["mod",{"_index":11,"title":{},"description":{"0":{}}}],["name",{"_index":97,"title":{"12":{}},"description":{"12":{},"17":{},"18":{},"19":{},"21":{},"23":{}}}],["need",{"_index":51,"title":{},"description":{"5":{}}}],["new",{"_index":57,"title":{"16":{}},"description":{"7":{},"14":{},"15":{},"16":{},"17":{},"22":{}}}],["normal",{"_index":156,"title":{},"description":{"23":{}}}],["on",{"_index":142,"title":{},"description":{"19":{}}}],["onc",{"_index":83,"title":{},"description":{"9":{}}}],["option",{"_index":46,"title":{"5":{},"15":{}},"description":{"5":{},"15":{},"21":{}}}],["output",{"_index":105,"title":{},"description":{"13":{}}}],["paramet",{"_index":25,"title":{},"description":{"1":{},"4":{},"5":{},"6":{},"14":{},"20":{},"22":{}}}],["pass",{"_index":7,"title":{},"description":{"0":{},"10":{}}}],["password",{"_index":34,"title":{"3":{},"10":{},"11":{}},"description":{"2":{},"3":{},"8":{},"10":{},"11":{}}}],["passwordless",{"_index":27,"title":{"2":{}},"description":{"2":{},"8":{}}}],["pend",{"_index":49,"title":{},"description":{"5":{}}}],["perform",{"_index":2,"title":{},"description":{"0":{},"2":{}}}],["player",{"_index":30,"title":{},"description":{"2":{},"3":{}}}],["possibl",{"_index":31,"title":{},"description":{"2":{}}}],["previous",{"_index":86,"title":{},"description":{"10":{},"11":{}}}],["privileg",{"_index":67,"title":{},"description":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["progress",{"_index":126,"title":{},"description":{"16":{}}}],["properti",{"_index":59,"title":{},"description":{"7":{}}}],["protect",{"_index":33,"title":{},"description":{"2":{},"3":{},"10":{}}}],["provid",{"_index":20,"title":{},"description":{"1":{},"7":{}}}],["queri",{"_index":41,"title":{"4":{}},"description":{}}],["queryserverst",{"_index":80,"title":{},"description":{"8":{}}}],["remot",{"_index":113,"title":{},"description":{"14":{},"22":{}}}],["remov",{"_index":90,"title":{},"description":{"10":{}}}],["renam",{"_index":82,"title":{"9":{}},"description":{"9":{}}}],["requir",{"_index":15,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"8":{},"9":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["requr",{"_index":93,"title":{},"description":{"10":{}}}],["respond",{"_index":153,"title":{},"description":{"23":{}}}],["respons",{"_index":158,"title":{},"description":{"23":{}}}],["restart",{"_index":53,"title":{},"description":{"5":{},"14":{},"22":{}}}],["restrict",{"_index":134,"title":{},"description":{"17":{},"18":{}}}],["retriev",{"_index":43,"title":{},"description":{"4":{},"5":{},"6":{}}}],["return",{"_index":21,"title":{},"description":{"1":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["run",{"_index":101,"title":{"13":{}},"description":{"13":{}}}],["satisfi",{"_index":132,"title":{},"description":{"17":{},"18":{}}}],["save",{"_index":63,"title":{"17":{},"18":{},"19":{},"22":{},"23":{}},"description":{"7":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["savenam",{"_index":131,"title":{},"description":{"17":{},"18":{}}}],["script",{"_index":110,"title":{},"description":{"14":{},"22":{}}}],["server",{"_index":4,"title":{"4":{},"5":{},"8":{},"9":{},"15":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"8":{},"9":{},"10":{},"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"20":{},"21":{},"22":{},"23":{}}}],["session",{"_index":52,"title":{"12":{},"19":{},"20":{}},"description":{"5":{},"12":{},"16":{},"17":{},"19":{}}}],["sessionnam",{"_index":141,"title":{},"description":{"19":{}}}],["set",{"_index":35,"title":{"6":{},"7":{},"10":{},"11":{},"12":{}},"description":{"2":{},"6":{},"7":{},"8":{},"10":{},"11":{},"14":{},"21":{},"22":{}}}],["setup",{"_index":111,"title":{},"description":{"14":{},"22":{}}}],["shut",{"_index":108,"title":{},"description":{"14":{},"22":{}}}],["shutdown",{"_index":107,"title":{"14":{}},"description":{"14":{},"22":{}}}],["specif",{"_index":140,"title":{},"description":{"19":{}}}],["startup",{"_index":98,"title":{},"description":{"12":{}}}],["state",{"_index":42,"title":{"4":{}},"description":{"4":{},"8":{}}}],["still",{"_index":48,"title":{},"description":{"5":{}}}],["string",{"_index":89,"title":{},"description":{"10":{}}}],["succcess",{"_index":148,"title":{},"description":{"21":{}}}],["success",{"_index":72,"title":{},"description":{"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"22":{},"23":{}}}],["system",{"_index":133,"title":{},"description":{"17":{},"18":{}}}],["take",{"_index":116,"title":{},"description":{"14":{},"22":{}}}],["temporarili",{"_index":123,"title":{},"description":{"16":{},"21":{}}}],["token",{"_index":19,"title":{"1":{}},"description":{"1":{},"10":{},"11":{},"14":{},"22":{}}}],["unavail",{"_index":124,"title":{},"description":{"16":{},"21":{}}}],["updat",{"_index":76,"title":{},"description":{"8":{},"10":{},"11":{},"12":{},"14":{},"22":{}}}],["upload",{"_index":150,"title":{"22":{}},"description":{}}],["us",{"_index":38,"title":{},"description":{"3":{},"8":{}}}],["valid",{"_index":23,"title":{},"description":{"1":{},"19":{}}}],["valu",{"_index":58,"title":{},"description":{"7":{}}}],["verifi",{"_index":18,"title":{"1":{}},"description":{"1":{}}}]],"pipeline":[]}},"options":{"htmlTemplate":"./docs/index.html"}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"Satisfactory Game Server HTTPS API specification","description":"Satisfactory Game Server HTTPS API specification","version":"0.1.1-preview-29","license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"}},"servers":[{"url":"https://localhost:7777"}],"paths":{"/api/v1/?function=HealthCheck":{"post":{"summary":"Health Check","operationId":"HealthCheck","description":"Performs a health check on the Dedicated Server API. Allows passing additional data between Modded Dedicated Server and Modded Game Client. This function requires no Authentication.","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthCheckRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/healthCheckResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=VerifyAuthenticationToken":{"post":{"summary":"Verify Authentication Token","operationId":"VerifyAuthenticationToken","description":"Verifies the Authentication token provided to the Dedicated Server API. Returns No Content if the provided token is valid. This function does not require input parameters and does not return any data.","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/verifyAuthenticationTokenRequest"}}},"required":true},"responses":{"204":{"description":"No Content - Authentication token is still valid"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=PasswordlessLogin":{"post":{"summary":"Passwordless Login","operationId":"PasswordlessLogin","description":"Attempts to perform a passwordless login to the Dedicated Server as a player. Passwordless login is possible if the Dedicated Server is not claimed, or if Client Protection Password is not set for the Dedicated Server. This function requires no Authentication.\n","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordlessLoginRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordlessLoginResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=PasswordLogin":{"post":{"summary":"Password Login","operationId":"PasswordLogin","description":"Attempts to log in to the Dedicated Server as a player using either Admin Password or Client Protection Password. This function requires no Authentication.\n","security":[{}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordLoginRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/passwordLoginResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"}}}},"/api/v1/?function=QueryServerState":{"post":{"summary":"Query Server State","operationId":"QueryServerState","description":"Retrieves the current state of the Dedicated Server. Does not require any input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queryServerStateRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queryServerStateResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=GetServerOptions":{"post":{"summary":"Get Server Options","operationId":"GetServerOptions","description":"Retrieves currently applied server options and server options that are still pending application (because of needing session or server restart) Does not require input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/getServerOptionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getServerOptionsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=GetAdvancedGameSettings":{"post":{"summary":"Get Advanced Game Settings","operationId":"GetAdvancedGameSettings","description":"Retrieves currently applied advanced game settings. Does not require input parameters.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/getAdvancedGameSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getAdvancedGameSettingsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ApplyAdvancedGameSettings":{"post":{"summary":"Apply Advanced Game Settings","operationId":"ApplyAdvancedGameSettings","description":"Applies new values to the provided Advanced Game Settings properties. Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applyAdvancedGameSettingsRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ClaimServer":{"post":{"summary":"Claim Server","operationId":"ClaimServer","description":"Claims this Dedicated Server if it is not claimed. Requires InitialAdmin privilege level, which can only be acquired by attempting passwordless login while the server does not have an Admin Password set, e.g. it is not claimed yet. Function does not return any data in case of success, and the server is claimed. The client should drop InitialAdmin privileges after that and use returned AuthenticationToken instead, and update it's cached server game state by calling QueryServerState.\n","security":[{"bearerAuth":["InitialAdmin"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimServerRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/claimServerResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=RenameServer":{"post":{"summary":"Rename Server","operationId":"RenameServer","description":"Renames the Dedicated Server once it has been claimed. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/renameServerRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetClientPassword":{"post":{"summary":"Set Client Password","operationId":"SetClientPassword","description":"Updates the currently set Client Protection Password. This will invalidate all previously issued Client authentication tokens. Pass empty string to remove the password, and let anyone join the server as Client. Requres Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setClientPasswordRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetAdminPassword":{"post":{"summary":"Set Admin Password","operationId":"SetAdminPassword","description":"Updates the currently set Admin Password. This will invalidate all previously issued Client and Admin authentication tokens. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAdminPasswordRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAdminPasswordResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SetAutoLoadSessionName":{"post":{"summary":"Set Auto Load Session Name","operationId":"SetAutoLoadSessionName","description":"Updates the name of the session that the Dedicated Server will automatically load on startup. Does not change currently loaded session. Requires Admin privileges. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/setAutoLoadSessionNameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=RunCommand":{"post":{"summary":"Run Command","operationId":"RunCommand","description":"Runs the given Console Command on the Dedicated Server, and returns it's output to the Console. Requires Admin privileges.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/runCommandRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=Shutdown":{"post":{"summary":"Shutdown","operationId":"Shutdown","description":"Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/shutdownRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=ApplyServerOptions":{"post":{"summary":"Apply Server Options","operationId":"ApplyServerOptions","description":"Applies new Server Options to the Dedicated Server. Requires Admin privileges.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/applyServerOptionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=CreateNewGame":{"post":{"summary":"Create New Game","operationId":"CreateNewGame","description":"Creates a new session on the Dedicated Server, and immediately loads it. HTTPS API becomes temporarily unavailable when map loading is in progress | Function does not return any data on success.\n","security":[{"bearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createNewGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"202":{"description":"Accepted - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=SaveGame":{"post":{"summary":"Save Game","operationId":"SaveGame","description":"Saves the currently loaded session into the new save game file named as the argument. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/saveGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DeleteSaveFile":{"post":{"summary":"Delete Save File","operationId":"DeleteSaveFile","description":"Deletes the existing save game file from the server. Requires Admin privileges. SaveName might be changed to satisfy file system restrictions on file names. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteSaveFileRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DeleteSaveSession":{"post":{"summary":"Delete Save Session","operationId":"DeleteSaveSession","description":"Deletes all save files belonging to the specific session name. Requires Admin privileges. SessionName must be a valid session name with at least one saved save game file belonging to it. Function does not return any data on success.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteSaveSessionRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=EnumerateSessions":{"post":{"summary":"Enumerate Sessions","operationId":"EnumerateSessions","description":"Enumerates all save game files available on the Dedicated Server. Requires Admin privileges. Function does not require any additional parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enumerateSessionsRequest"}}},"required":true},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/enumerateSessionsResponse"}}}},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=LoadGame":{"post":{"summary":"Load Game","operationId":"LoadGame","description":"Loads the save game file by name, optionally with Advanced Game Settings enabled. Requires Admin privileges. Dedicated Server HTTPS API will become temporarily unavailable when save game is being loaded. Function does not return any data on succcess.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loadGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=UploadSaveGame":{"post":{"summary":"Upload Save Game","operationId":"UploadSaveGame","description":"Shuts down the Dedicated Server. If automatic restart script is setup, this allows restarting the server to apply new settings or update. Requires Admin privileges. Shutdowns initiated by remote hosts are logged with their IP and their token. Function does not return any data on success, and does not take any parameters.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/uploadSaveGameRequest"},"encoding":{"function":{"contentType":"application/json"},"data":{"contentType":"application/json"},"saveGameFile":{"contentType":"application/octet-stream"}}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}},"/api/v1/?function=DownloadSaveGame":{"post":{"summary":"Download Save Game","operationId":"DownloadSaveGame","description":"Downloads save game with the given name from the Dedicated Server. Requires Admin privileges. This function responds with the file attachment containing the save game file on success, and with normal error response in case of error.\n","security":[{"bearerAuth":["Administrator"]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloadSaveGameRequest"}}},"required":true},"responses":{"200":{"description":"Ok - Error","$ref":"#/components/responses/error"},"204":{"description":"No Content - Success"},"400":{"description":"Bad request","$ref":"#/components/responses/error"},"401":{"description":"Unauthorized","$ref":"#/components/responses/error"},"403":{"description":"Forbidden","$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"healthCheckRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"HealthCheck","default":"HealthCheck","example":"HealthCheck"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"clientCustomData":{"type":"string","description":"Custom Data passed from the Game Client or Third Party service. Not used by vanilla Dedicated Servers"}},"required":["clientCustomData"]}},"required":["function","data"]},"error":{"type":"object","title":"error","properties":{"errorCode":{"type":"string","description":"Machine-friendly code indicating the type of the error that the executed function returned"},"errorMessage":{"type":"string","description":"Optional. Human-friendly error message explaining the error"},"errorData":{"type":"object","description":"Optional. Additional information about the error, for example, list of parameters that are missing"}},"required":["errorCode"]},"healthCheckResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","properties":{"health":{"type":"string","enum":["healthy","slow"],"description":"healthy if tick rate is above ten ticks per second, slow otherwise"},"serverCustomData":{"type":"string","description":"Custom Data passed from the Dedicated Server to the Game Client or Third Party service. Vanilla Dedicated Server returns empty string"}},"required":["health"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"verifyAuthenticationTokenRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"VerifyAuthenticationToken","default":"VerifyAuthenticationToken","example":"VerifyAuthenticationToken"}},"required":["function"]},"privilegeLevel":{"type":"string","description":"Privilege Level granted of a Authorization/Authentication token.\n- `NotAuthenticated`: The client is not Authenticated\n- `Client`: Client is Authenticated with Client privileges\n- `Administrator`: Client is Authenticated with Admin privileges\n- `InitialAdmin: Client is Authenticated as Initial Admin with privileges to Claim the server\n- `APIToken`: Client is Authenticated as Third Party Application\n","enum":["NotAuthenticated","Client","Administrator","InitialAdmin","APIToken"]},"passwordlessLoginRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"PasswordlessLogin","default":"PasswordlessLogin","example":"PasswordlessLogin"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"minimumPrivilegeLevel":{"$ref":"#/components/schemas/privilegeLevel","description":"Minimum privilege level to attempt to acquire by logging in.","example":"InitialAdmin"}},"required":["minimumPrivilegeLevel"]}},"required":["function","data"]},"passwordlessLoginResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"Authentication Token in case login is successful"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"passwordLoginRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"PasswordLogin","default":"PasswordLogin","example":"PasswordLogin"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"minimumPrivilegeLevel":{"$ref":"#/components/schemas/privilegeLevel","description":"Minimum privilege level to attempt to acquire by logging in.","example":"Administator"},"password":{"type":"string","description":"Password to attempt to log in with, in plaintext","example":"super-secret-password"}},"required":["minimumPrivilegeLevel","password"]}},"required":["function","data"]},"passwordLoginResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"Authentication Token in case login is successful"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"queryServerStateRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"QueryServerState","default":"QueryServerState","example":"QueryServerState"}},"required":["function"]},"queryServerStateResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"serverGameState":{"type":"object","description":"Current game state of the server","properties":{"activeSessionName":{"type":"string","description":"Name of the currently loaded game session","example":"SERVER-SESSION26924571"},"numConnectedPlayers":{"type":"integer","description":"Number of the players currently connected to the Dedicated Server","example":0},"playerLimit":{"type":"integer","description":"Maximum number of players that can be connected to the Dedicated Server","example":4},"techTier":{"type":"integer","description":"Maximum Tech Tier of all Schematics currently unlocked","example":0},"activeSchematic":{"type":"string","description":"Schematic currently set as Active Milestone","example":"None"},"gamePhase":{"type":"string","description":"Current game phase. None if no game is running","example":"None"},"isGameRunning":{"type":"boolean","description":"True if the save is currently loaded, false if the server is waiting for the session to be created","example":false},"totalGameDuration":{"type":"integer","description":"Total time the current save has been loaded, in seconds","example":0},"isGamePaused":{"type":"boolean","description":"True if the game is paused. If the game is paused, total game duration does not increase","example":false},"averageTickRate":{"type":"number","description":"Average tick rate of the server, in ticks per second","format":"float","example":29.89044189453125},"autoLoadSessionName":{"type":"string","description":"Name of the session that will be loaded when the server starts automatically","example":"SERVER-SESSION26924571"}},"required":["activeSessionName","numConnectedPlayers","playerLimit","techTier","activeSchematic","gamePhase","isGameRunning","totalGameDuration","isGamePaused","averageTickRate","autoLoadSessionName"]}},"required":["serverGameState"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"getServerOptionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"GetServerOptions","default":"GetServerOptions","example":"GetServerOptions"}},"required":["function"]},"serverOptions":{"type":"object","description":"All current server option values, where keys are the option names and values are their stringified values.","additionalProperties":{"type":"string"},"example":{"FG.DSAutoPause":"True","FG.DSAutoSaveOnDisconnect":"True","FG.DisableSeasonalEvents":"False","FG.AutosaveInterval":"300.0","FG.ServerRestartTimeSlot":"1440.0","FG.SendGameplayData":"True","FG.NetworkQuality":"1"}},"getServerOptionsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"serverOptions":{"$ref":"#/components/schemas/serverOptions"},"pendingServerOptions":{"description":"Server option values that will be applied when the session or server restarts, where keys are the option names and values are their stringified values.","$ref":"#/components/schemas/serverOptions"}},"required":["serverOptions","pendingServerOptions"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"getAdvancedGameSettingsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"GetAdvancedGameSettings","default":"GetAdvancedGameSettings","example":"GetAdvancedGameSettings"}},"required":["function"]},"advancedGameSettings":{"type":"object","properties":{"creativeModeEnabled":{"type":"boolean","description":"True if Advanced Game Settings are enabled for the currently loaded session","example":false},"advancedGameSettings":{"type":"object","description":"Values of Advanced Game Settings. Key is the name of the setting, and value is its stringified value","additionalProperties":{"type":"string"},"example":{"FG.GameRules.NoPower":"False","FG.GameRules.StartingTier":"0","FG.GameRules.DisableArachnidCreatures":"False","FG.GameRules.NoUnlockCost":"False","FG.GameRules.SetGamePhase":"0","FG.GameRules.UnlockAllResearchSchematics":"False","FG.GameRules.UnlockInstantAltRecipes":"False","FG.GameRules.UnlockAllResourceSinkSchematics":"False","FG.PlayerRules.NoBuildCost":"False","FG.PlayerRules.GodMode":"False","FG.PlayerRules.FlightMode":"False"}}},"required":["creativeModeEnabled","advancedGameSettings"]},"getAdvancedGameSettingsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","$ref":"#/components/schemas/advancedGameSettings"}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"applyAdvancedGameSettingsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ApplyAdvancedGameSettings","default":"ApplyAdvancedGameSettings","example":"ApplyAdvancedGameSettings"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","$ref":"#/components/schemas/advancedGameSettings"}},"required":["function","data"]},"claimServerRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ClaimServer","default":"ClaimServer","example":"ClaimServer"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"serverName":{"type":"string","description":"New name of the Dedicated Server","example":"Test Server"},"adminPassword":{"type":"string","description":"Admin Password to set on the Dedicated Server, in plaintext","example":"super-secret-password"}},"required":["serverName","adminPassword"]}},"required":["function","data"]},"claimServerResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"New Authentication Token that the Caller should use to drop Initial Admin privileges"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"renameServerRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"RenameServer","default":"RenameServer","example":"RenameServer"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"serverName":{"type":"string","description":"New name of the Dedicated Server","example":"Not Test Server"}},"required":["serverName"]}},"required":["function","data"]},"setClientPasswordRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetClientPassword","default":"SetClientPassword","example":"SetClientPassword"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"password":{"type":"string","description":"Client Password to set on the Dedicated Server, in plaintext","example":"password-used-to-play-on-the-server"}},"required":["password"]}},"required":["function","data"]},"setAdminPasswordRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetAdminPassword","default":"SetAdminPassword","example":"SetAdminPassword"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"password":{"type":"string","description":"Admin Password to set on the Dedicated Server, in plaintext","example":"super-secret-password"}},"required":["password"]}},"required":["function","data"]},"setAdminPasswordResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"authenticationToken":{"type":"string","description":"New Admin authentication token to use, since the token used for this request will become invalidated"}},"required":["authenticationToken"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"setAutoLoadSessionNameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SetAutoLoadSessionName","default":"SetAutoLoadSessionName","example":"SetAutoLoadSessionName"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"sessionName":{"type":"string","description":"Name of the session to automatically load on Dedicated Server startup","example":"Test"}},"required":["sessionName"]}},"required":["function","data"]},"runCommandRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"RunCommand","default":"RunCommand","example":"RunCommand"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"command":{"type":"string","description":"Command Line to run on the Dedicated Server"}},"required":["command"]}},"required":["function","data"]},"shutdownRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"Shutdown","default":"Shutdown","example":"Shutdown"}},"required":["function"]},"applyServerOptionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"ApplyServerOptions","default":"ApplyServerOptions","example":"ApplyServerOptions"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"updatedServerOptions":{"description":"Key is the name of the Server Option, and the Value is the new value as string","$ref":"#/components/schemas/serverOptions"}},"required":["updatedServerOptions"]}},"required":["function","data"]},"createNewGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"CreateNewGame","default":"CreateNewGame","example":"CreateNewGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"newGameData":{"type":"object","description":"Key is the name of the Server Option, and the Value is the new value as string","properties":{"sessionName":{"type":"string","description":"Name of the session to create","example":"Test"},"mapName":{"type":"string","description":"Path Name to the Map Package to use as a map. If not specified, default level","example":""},"startingLocation":{"type":"string","description":"Name of the starting location to use. Leaving it empty will use random starting location","example":""},"bSkipOnboarding":{"type":"boolean","example":false,"description":"Whether the Onboarding should be skipped. Currently, Onboarding is always skipped on the Dedicated Servers. Currently SkipOnboarding must be set to bSkipOnboarding, due to an issue with the property names."},"advancedGameSettings":{"description":"Advanced Game Settings to apply to the newly created session","$ref":"#/components/schemas/advancedGameSettings"},"customOptionsOnlyForModding":{"type":"object","description":"Custom Options to pass to the newly created session URL. Not used by vanilla Dedicated Servers","additionalProperties":{"type":"string"},"example":{}}},"required":["sessionName","mapName","startingLocation","bSkipOnboarding"]}},"required":["newGameData"]}},"required":["function","data"]},"saveGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"SaveGame","default":"SaveGame","example":"SaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to create. Passed name might be sanitized","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]},"deleteSaveFileRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DeleteSaveFile","default":"DeleteSaveFile","example":"DeleteSaveFile"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to delete. Passed name might be sanitized","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]},"deleteSaveSessionRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DeleteSaveSession","default":"DeleteSaveSession","example":"DeleteSaveSession"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"sessionName":{"type":"string","description":"Name of the save session to delete","example":"Test"}},"required":["sessionName"]}},"required":["function","data"]},"enumerateSessionsRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"EnumerateSessions","default":"EnumerateSessions","example":"EnumerateSessions"}},"required":["function"]},"saveHeader":{"type":"object","properties":{"saveVersion":{"type":"integer","description":"Version of the Save Game format this file was saved with","example":46},"buildVersion":{"type":"integer","description":"Changelist of the game or dedicated server this file was saved by","example":368883},"saveName":{"type":"string","description":"Name of the save game file in the filesystem","example":"Test_autosave_0"},"saveLocationInfo":{"type":"string","description":"Unknown - Not listed in official documentation","example":"SLI_Server"},"mapName":{"type":"string","description":"Path to the map package this save game file is based on","example":"Persistent_Level"},"mapOptions":{"type":"string","description":"Additional Map URL options this save game was saved with","example":"?skiponboarding"},"sessionName":{"type":"string","description":"Name of the session this save game file belongs to","example":"Test"},"playDurationSeconds":{"type":"integer","description":"Amount of seconds the game has been running for in total since the session was created","example":30},"saveDateTime":{"type":"string","description":"Date and time on which the save game file was saved","example":"2024.09.28-04.00.32"},"isModdedSave":{"type":"boolean","description":"True if this save game file was saved with mods","example":false},"isEditedSave":{"type":"boolean","description":"True if this save game file has been edited by third party tools","example":false},"isCreativeModeEnabled":{"type":"boolean","description":"True if Advanced Game Settings are enabled for this save game","example":false}},"required":["saveVersion","buildVersion","saveName","mapName","mapOptions","sessionName","playDurationSeconds","saveDateTime","isModdedSave","isEditedSave","isCreativeModeEnabled"]},"sessionSaveStruct":{"type":"object","properties":{"sessionName":{"type":"string","description":"Name of the save session","example":"Test"},"saveHeaders":{"type":"array","description":"All save game files belonging to this session","items":{"$ref":"#/components/schemas/saveHeader"}}},"required":["sessionName","saveHeaders"]},"enumerateSessionsResponse":{"oneOf":[{"type":"object","title":"success","properties":{"data":{"type":"object","description":"Data returned by the function executed. Type depends on the function the request performed","properties":{"sessions":{"type":"array","description":"List of sessions available on the Dedicated Server","items":{"$ref":"#/components/schemas/sessionSaveStruct"}},"currentSessionIndex":{"type":"integer","description":"Index of the currently selected session in the list","example":0}},"required":["sessions","currentSessionIndex"]}},"required":["data"]},{"$ref":"#/components/schemas/error"}]},"loadGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"LoadGame","default":"LoadGame","example":"LoadGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to load","example":"Test Save 1"},"enableAdvancedGameSettings":{"type":"boolean","description":"True if save game file should be loaded with Advanced Game Settings enabled","example":false}},"required":["saveName","enableAdvancedGameSettings"]}},"required":["function","data"]},"uploadSaveGameRequest":{"type":"object","properties":{"data":{"type":"object","description":"Standard Request Data body for this request, encoded as UTF-8 JSON. Note that this includes the envelope.","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"UploadSaveGame","default":"UploadSaveGame","example":"UploadSaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to create on the Dedicated Server.","example":"Uploaded Save"},"loadSaveGame":{"type":"boolean","description":"True if the save game file should be immediately loaded by the Dedicated Server.","example":true},"enableAdvancedGameSettings":{"type":"boolean","description":"True if the save game file should be loaded with Advanced Game Settings enabled.","example":false}},"required":["saveName","loadSaveGame","enableAdvancedGameSettings"]}},"required":["function","data"]},"saveGameFile":{"type":"string","format":"binary","description":"File attachment containing the save game file. Contents of the file will be validated on the server."}},"required":["data","saveGameFile"]},"downloadSaveGameRequest":{"type":"object","properties":{"function":{"type":"string","description":"Name of the API function to execute.","const":"DownloadSaveGame","default":"DownloadSaveGame","example":"DownloadSaveGame"},"data":{"type":"object","description":"Data to pass to the function to execute. Format of the object depends on the function being executed","properties":{"saveName":{"type":"string","description":"Name of the save game file to download from the Dedicated Server","example":"Test Save 1"}},"required":["saveName"]}},"required":["function","data"]}},"responses":{"error":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}}}},"searchIndex":{"store":["operation/HealthCheck","operation/VerifyAuthenticationToken","operation/PasswordlessLogin","operation/PasswordLogin","operation/QueryServerState","operation/GetServerOptions","operation/GetAdvancedGameSettings","operation/ApplyAdvancedGameSettings","operation/ClaimServer","operation/RenameServer","operation/SetClientPassword","operation/SetAdminPassword","operation/SetAutoLoadSessionName","operation/RunCommand","operation/Shutdown","operation/ApplyServerOptions","operation/CreateNewGame","operation/SaveGame","operation/DeleteSaveFile","operation/DeleteSaveSession","operation/EnumerateSessions","operation/LoadGame","operation/UploadSaveGame","operation/DownloadSaveGame"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.551,1,2.551]],["description/0",[0,2.312,1,2.312,2,2.312,3,0.573,4,0.028,5,1.722,6,1.974,7,2.312,8,2.312,9,0.547,10,2.825,11,3.879,12,0.358,13,1.209,14,0.302,15,0.151,16,1.209,17,2.825]],["title/1",[16,1.137,18,2.175,19,1.273]],["description/1",[3,0.434,4,0.021,5,1.791,9,0.569,14,0.315,15,0.158,16,1.258,18,2.405,19,1.908,20,3.262,21,0.772,22,2.939,23,2.405,24,1.791,25,1.258,26,2.939]],["title/2",[27,2.178,28,1.9]],["description/2",[2,2.226,3,0.641,4,0.031,13,1.164,14,0.291,15,0.146,16,1.164,27,2.641,28,2.303,29,1.9,30,2.226,31,2.719,32,1.658,33,1.9,34,1.043,35,0.527,36,2.719]],["title/3",[28,1.9,34,1.195]],["description/3",[3,0.472,4,0.023,13,1.368,14,0.342,15,0.171,16,1.368,29,2.234,30,2.616,33,2.234,34,1.616,37,2.234,38,2.616,39,0.405,40,3.196]],["title/4",[4,0.019,41,2.658,42,1.858]],["description/4",[3,0.544,4,0.026,15,0.197,24,2.243,25,1.575,42,2.572,43,2.572,44,1.411,45,3.68]],["title/5",[4,0.022,46,1.678]],["description/5",[4,0.033,15,0.161,24,1.828,25,1.283,43,2.096,44,1.15,46,2.174,47,1.15,48,2.999,49,2.999,50,2.999,51,2.999,52,1.15,53,2.096,54,2.999]],["title/6",[12,0.337,35,0.515,55,1.431]],["description/6",[12,0.455,15,0.192,24,2.188,25,1.536,35,0.695,43,2.508,44,1.376,47,1.376,55,1.932,56,3.589]],["title/7",[12,0.294,35,0.449,47,0.888,55,1.247]],["description/7",[12,0.505,20,2.405,35,0.772,44,1.127,47,1.127,55,2.145,57,1.258,58,2.939,59,2.939,60,1.791,61,3.262,62,1.258,63,0.724,64,2.939,65,2.939]],["title/8",[4,0.022,32,1.9]],["description/8",[3,0.297,4,0.029,9,0.389,12,0.255,13,0.859,14,0.215,15,0.108,21,0.587,27,1.403,28,1.224,29,1.403,32,2.481,34,0.77,35,0.389,38,1.643,39,0.255,42,1.403,66,3.032,67,0.515,68,2.008,69,2.008,70,2.008,71,1.643,72,0.495,73,2.008,74,2.008,75,2.008,76,0.961,77,1.643,78,2.008,79,2.008,80,2.008,81,2.008]],["title/9",[4,0.022,82,2.551]],["description/9",[3,0.494,4,0.024,9,0.647,14,0.358,15,0.179,21,0.647,32,2.037,39,0.424,67,0.568,72,0.824,82,2.736,83,3.343,84,3.343]],["title/10",[13,1.137,34,1.019,35,0.515]],["description/10",[4,0.018,7,2.002,9,0.474,13,1.754,14,0.262,16,1.047,19,1.171,21,0.474,33,1.709,34,1.344,35,0.474,39,0.31,44,0.938,67,0.416,72,0.603,76,1.171,85,2.002,86,2.002,87,2.002,88,2.446,89,2.446,90,2.446,91,2.446,92,2.446,93,2.446,94,2.446]],["title/11",[34,1.019,35,0.515,39,0.337]],["description/11",[9,0.558,13,1.233,14,0.308,15,0.154,16,1.233,19,1.379,21,0.558,34,1.105,35,0.558,39,0.567,44,1.105,67,0.489,72,0.71,76,1.379,85,2.358,86,2.358,87,2.358,95,2.881]],["title/12",[35,0.398,52,0.787,62,0.879,96,2.053,97,0.879]],["description/12",[3,0.425,4,0.021,9,0.558,14,0.308,15,0.154,21,0.558,39,0.365,44,1.105,52,1.508,60,1.756,62,1.682,67,0.489,72,0.71,76,1.379,97,1.233,98,2.881,99,2.013,100,2.881]],["title/13",[101,2.551,102,2.551]],["description/13",[3,0.483,4,0.023,15,0.175,21,0.633,39,0.414,67,0.555,77,2.674,101,2.674,102,2.674,103,2.674,104,4.277,105,3.268,106,3.268]],["title/14",[107,2.633]],["description/14",[3,0.344,4,0.024,6,1.627,9,0.451,14,0.249,15,0.125,19,1.115,21,0.451,25,0.997,35,0.451,37,1.627,39,0.295,47,0.893,53,2.365,57,0.997,60,1.419,67,0.396,72,0.574,76,1.115,107,1.627,108,1.906,109,1.906,110,1.906,111,1.906,112,1.906,113,1.906,114,1.906,115,1.906,116,1.906,117,2.329]],["title/15",[4,0.019,46,1.431,47,1.019]],["description/15",[3,0.53,4,0.033,15,0.192,39,0.455,46,1.932,47,1.376,57,1.536,67,0.61,118,3.589]],["title/16",[12,0.337,57,1.137,119,2.175]],["description/16",[3,0.417,4,0.02,5,1.722,9,0.547,14,0.302,21,0.547,52,1.083,57,1.209,62,1.66,72,0.696,119,2.312,120,2.825,121,2.312,122,2.312,123,2.312,124,2.312,125,2.825,126,2.825,127,2.825,128,2.825]],["title/17",[12,0.395,63,0.768]],["description/17",[9,0.499,12,0.326,14,0.276,15,0.138,21,0.499,39,0.326,44,0.988,52,0.988,57,1.102,62,1.102,63,0.896,67,0.438,72,0.635,97,1.557,99,1.8,129,1.805,130,2.575,131,2.108,132,2.108,133,2.108,134,2.108,135,2.575]],["title/18",[63,0.655,129,1.137,136,1.62]],["description/18",[4,0.02,9,0.537,12,0.351,14,0.297,15,0.149,21,0.537,39,0.351,63,0.683,67,0.471,72,0.683,97,1.186,99,1.937,129,1.877,131,2.268,132,2.268,133,2.268,134,2.268,136,1.689,137,2.771,138,2.771]],["title/19",[52,1.019,63,0.655,136,1.62]],["description/19",[9,0.508,12,0.332,14,0.281,15,0.141,21,0.508,23,2.146,39,0.332,52,1.412,63,1.049,67,0.445,72,0.646,97,1.576,129,1.576,136,1.598,139,3.683,140,2.622,141,2.622,142,2.622,143,2.622]],["title/20",[52,1.195,144,2.551]],["description/20",[3,0.472,4,0.023,8,2.616,12,0.405,14,0.342,15,0.226,25,1.368,39,0.405,63,0.787,67,0.543,129,1.368,144,2.616,145,3.196,146,3.196]],["title/21",[12,0.395,62,1.334]],["description/21",[3,0.361,4,0.018,5,1.491,9,0.474,12,0.52,14,0.262,15,0.131,21,0.474,35,0.474,39,0.31,46,1.316,55,1.316,61,2.002,62,1.5,63,0.864,67,0.416,97,1.047,121,2.002,122,2.002,123,2.002,124,2.002,129,1.047,147,2.446,148,2.446,149,2.446]],["title/22",[12,0.337,63,0.655,150,2.658]],["description/22",[3,0.344,4,0.024,6,1.627,9,0.451,14,0.249,15,0.125,19,1.115,21,0.451,25,0.997,35,0.451,37,1.627,39,0.295,47,0.893,53,2.365,57,0.997,60,1.419,67,0.396,72,0.574,76,1.115,107,1.627,108,1.906,109,1.906,110,1.906,111,1.906,112,1.906,113,1.906,114,1.906,115,1.906,116,1.906,151,2.329]],["title/23",[12,0.337,63,0.655,152,2.175]],["description/23",[3,0.387,4,0.019,12,0.467,14,0.281,15,0.141,39,0.332,63,0.907,67,0.445,71,2.146,72,0.646,97,1.122,103,2.146,129,1.576,152,2.146,153,2.622,154,2.622,155,2.622,156,2.622,157,3.683,158,2.622,159,2.622]]],"invertedIndex":[["",{"_index":127,"title":{},"description":{"16":{}}}],["acquir",{"_index":69,"title":{},"description":{"8":{}}}],["addit",{"_index":8,"title":{},"description":{"0":{},"20":{}}}],["admin",{"_index":39,"title":{"11":{}},"description":{"3":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["advanc",{"_index":55,"title":{"6":{},"7":{}},"description":{"6":{},"7":{},"21":{}}}],["allow",{"_index":6,"title":{},"description":{"0":{},"14":{},"22":{}}}],["alreadi",{"_index":64,"title":{},"description":{"7":{}}}],["anyon",{"_index":91,"title":{},"description":{"10":{}}}],["api",{"_index":5,"title":{},"description":{"0":{},"1":{},"16":{},"21":{}}}],["api/v1/?function=applyadvancedgameset",{"_index":65,"title":{},"description":{"7":{}}}],["api/v1/?function=applyserveropt",{"_index":118,"title":{},"description":{"15":{}}}],["api/v1/?function=claimserv",{"_index":81,"title":{},"description":{"8":{}}}],["api/v1/?function=createnewgam",{"_index":128,"title":{},"description":{"16":{}}}],["api/v1/?function=deletesavefil",{"_index":138,"title":{},"description":{"18":{}}}],["api/v1/?function=deletesavesess",{"_index":143,"title":{},"description":{"19":{}}}],["api/v1/?function=downloadsavegam",{"_index":159,"title":{},"description":{"23":{}}}],["api/v1/?function=enumeratesess",{"_index":146,"title":{},"description":{"20":{}}}],["api/v1/?function=getadvancedgameset",{"_index":56,"title":{},"description":{"6":{}}}],["api/v1/?function=getserveropt",{"_index":54,"title":{},"description":{"5":{}}}],["api/v1/?function=healthcheck",{"_index":17,"title":{},"description":{"0":{}}}],["api/v1/?function=loadgam",{"_index":149,"title":{},"description":{"21":{}}}],["api/v1/?function=passwordlesslogin",{"_index":36,"title":{},"description":{"2":{}}}],["api/v1/?function=passwordlogin",{"_index":40,"title":{},"description":{"3":{}}}],["api/v1/?function=queryserverst",{"_index":45,"title":{},"description":{"4":{}}}],["api/v1/?function=renameserv",{"_index":84,"title":{},"description":{"9":{}}}],["api/v1/?function=runcommand",{"_index":106,"title":{},"description":{"13":{}}}],["api/v1/?function=savegam",{"_index":135,"title":{},"description":{"17":{}}}],["api/v1/?function=setadminpassword",{"_index":95,"title":{},"description":{"11":{}}}],["api/v1/?function=setautoloadsessionnam",{"_index":100,"title":{},"description":{"12":{}}}],["api/v1/?function=setclientpassword",{"_index":94,"title":{},"description":{"10":{}}}],["api/v1/?function=shutdown",{"_index":117,"title":{},"description":{"14":{}}}],["api/v1/?function=uploadsavegam",{"_index":151,"title":{},"description":{"22":{}}}],["api/v1/?function=verifyauthenticationtoken",{"_index":26,"title":{},"description":{"1":{}}}],["appli",{"_index":47,"title":{"7":{},"15":{}},"description":{"5":{},"6":{},"7":{},"14":{},"15":{},"22":{}}}],["applic",{"_index":50,"title":{},"description":{"5":{}}}],["argument",{"_index":130,"title":{},"description":{"17":{}}}],["attach",{"_index":154,"title":{},"description":{"23":{}}}],["attempt",{"_index":29,"title":{},"description":{"2":{},"3":{},"8":{}}}],["authent",{"_index":16,"title":{"1":{}},"description":{"0":{},"1":{},"2":{},"3":{},"10":{},"11":{}}}],["authenticationtoken",{"_index":74,"title":{},"description":{"8":{}}}],["auto",{"_index":96,"title":{"12":{}},"description":{}}],["automat",{"_index":60,"title":{},"description":{"7":{},"12":{},"14":{},"22":{}}}],["avail",{"_index":145,"title":{},"description":{"20":{}}}],["be",{"_index":147,"title":{},"description":{"21":{}}}],["becom",{"_index":122,"title":{},"description":{"16":{},"21":{}}}],["belong",{"_index":139,"title":{},"description":{"19":{}}}],["between",{"_index":10,"title":{},"description":{"0":{}}}],["cach",{"_index":78,"title":{},"description":{"8":{}}}],["call",{"_index":79,"title":{},"description":{"8":{}}}],["case",{"_index":71,"title":{},"description":{"8":{},"23":{}}}],["chang",{"_index":99,"title":{},"description":{"12":{},"17":{},"18":{}}}],["check",{"_index":1,"title":{"0":{}},"description":{"0":{}}}],["claim",{"_index":32,"title":{"8":{}},"description":{"2":{},"8":{},"9":{}}}],["client",{"_index":13,"title":{"10":{}},"description":{"0":{},"2":{},"3":{},"8":{},"10":{},"11":{}}}],["command",{"_index":102,"title":{"13":{}},"description":{"13":{}}}],["consol",{"_index":104,"title":{},"description":{"13":{}}}],["contain",{"_index":155,"title":{},"description":{"23":{}}}],["content",{"_index":22,"title":{},"description":{"1":{}}}],["creat",{"_index":119,"title":{"16":{}},"description":{"16":{}}}],["current",{"_index":44,"title":{},"description":{"4":{},"5":{},"6":{},"7":{},"10":{},"11":{},"12":{},"17":{}}}],["data",{"_index":9,"title":{},"description":{"0":{},"1":{},"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["dedic",{"_index":3,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"8":{},"9":{},"12":{},"13":{},"14":{},"15":{},"16":{},"20":{},"21":{},"22":{},"23":{}}}],["delet",{"_index":136,"title":{"18":{},"19":{}},"description":{"18":{},"19":{}}}],["down",{"_index":109,"title":{},"description":{"14":{},"22":{}}}],["download",{"_index":152,"title":{"23":{}},"description":{"23":{}}}],["drop",{"_index":73,"title":{},"description":{"8":{}}}],["e.g",{"_index":70,"title":{},"description":{"8":{}}}],["empti",{"_index":88,"title":{},"description":{"10":{}}}],["enabl",{"_index":61,"title":{},"description":{"7":{},"21":{}}}],["enumer",{"_index":144,"title":{"20":{}},"description":{"20":{}}}],["error",{"_index":157,"title":{},"description":{"23":{}}}],["exist",{"_index":137,"title":{},"description":{"18":{}}}],["file",{"_index":129,"title":{"18":{}},"description":{"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["function",{"_index":14,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["game",{"_index":12,"title":{"6":{},"7":{},"16":{},"17":{},"21":{},"22":{},"23":{}},"description":{"0":{},"6":{},"7":{},"8":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["given",{"_index":103,"title":{},"description":{"13":{},"23":{}}}],["health",{"_index":0,"title":{"0":{}},"description":{"0":{}}}],["host",{"_index":114,"title":{},"description":{"14":{},"22":{}}}],["http",{"_index":121,"title":{},"description":{"16":{},"21":{}}}],["immedi",{"_index":120,"title":{},"description":{"16":{}}}],["initi",{"_index":112,"title":{},"description":{"14":{},"22":{}}}],["initialadmin",{"_index":66,"title":{},"description":{"8":{}}}],["input",{"_index":24,"title":{},"description":{"1":{},"4":{},"5":{},"6":{}}}],["instead",{"_index":75,"title":{},"description":{"8":{}}}],["invalid",{"_index":85,"title":{},"description":{"10":{},"11":{}}}],["ip",{"_index":115,"title":{},"description":{"14":{},"22":{}}}],["issu",{"_index":87,"title":{},"description":{"10":{},"11":{}}}],["it'",{"_index":77,"title":{},"description":{"8":{},"13":{}}}],["join",{"_index":92,"title":{},"description":{"10":{}}}],["level",{"_index":68,"title":{},"description":{"8":{}}}],["load",{"_index":62,"title":{"12":{},"21":{}},"description":{"7":{},"12":{},"16":{},"17":{},"21":{}}}],["log",{"_index":37,"title":{},"description":{"3":{},"14":{},"22":{}}}],["login",{"_index":28,"title":{"2":{},"3":{}},"description":{"2":{},"8":{}}}],["map",{"_index":125,"title":{},"description":{"16":{}}}],["mod",{"_index":11,"title":{},"description":{"0":{}}}],["name",{"_index":97,"title":{"12":{}},"description":{"12":{},"17":{},"18":{},"19":{},"21":{},"23":{}}}],["need",{"_index":51,"title":{},"description":{"5":{}}}],["new",{"_index":57,"title":{"16":{}},"description":{"7":{},"14":{},"15":{},"16":{},"17":{},"22":{}}}],["normal",{"_index":156,"title":{},"description":{"23":{}}}],["on",{"_index":142,"title":{},"description":{"19":{}}}],["onc",{"_index":83,"title":{},"description":{"9":{}}}],["option",{"_index":46,"title":{"5":{},"15":{}},"description":{"5":{},"15":{},"21":{}}}],["output",{"_index":105,"title":{},"description":{"13":{}}}],["paramet",{"_index":25,"title":{},"description":{"1":{},"4":{},"5":{},"6":{},"14":{},"20":{},"22":{}}}],["pass",{"_index":7,"title":{},"description":{"0":{},"10":{}}}],["password",{"_index":34,"title":{"3":{},"10":{},"11":{}},"description":{"2":{},"3":{},"8":{},"10":{},"11":{}}}],["passwordless",{"_index":27,"title":{"2":{}},"description":{"2":{},"8":{}}}],["pend",{"_index":49,"title":{},"description":{"5":{}}}],["perform",{"_index":2,"title":{},"description":{"0":{},"2":{}}}],["player",{"_index":30,"title":{},"description":{"2":{},"3":{}}}],["possibl",{"_index":31,"title":{},"description":{"2":{}}}],["previous",{"_index":86,"title":{},"description":{"10":{},"11":{}}}],["privileg",{"_index":67,"title":{},"description":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["progress",{"_index":126,"title":{},"description":{"16":{}}}],["properti",{"_index":59,"title":{},"description":{"7":{}}}],["protect",{"_index":33,"title":{},"description":{"2":{},"3":{},"10":{}}}],["provid",{"_index":20,"title":{},"description":{"1":{},"7":{}}}],["queri",{"_index":41,"title":{"4":{}},"description":{}}],["queryserverst",{"_index":80,"title":{},"description":{"8":{}}}],["remot",{"_index":113,"title":{},"description":{"14":{},"22":{}}}],["remov",{"_index":90,"title":{},"description":{"10":{}}}],["renam",{"_index":82,"title":{"9":{}},"description":{"9":{}}}],["requir",{"_index":15,"title":{},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"8":{},"9":{},"11":{},"12":{},"13":{},"14":{},"15":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{}}}],["requr",{"_index":93,"title":{},"description":{"10":{}}}],["respond",{"_index":153,"title":{},"description":{"23":{}}}],["respons",{"_index":158,"title":{},"description":{"23":{}}}],["restart",{"_index":53,"title":{},"description":{"5":{},"14":{},"22":{}}}],["restrict",{"_index":134,"title":{},"description":{"17":{},"18":{}}}],["retriev",{"_index":43,"title":{},"description":{"4":{},"5":{},"6":{}}}],["return",{"_index":21,"title":{},"description":{"1":{},"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"16":{},"17":{},"18":{},"19":{},"21":{},"22":{}}}],["run",{"_index":101,"title":{"13":{}},"description":{"13":{}}}],["satisfi",{"_index":132,"title":{},"description":{"17":{},"18":{}}}],["save",{"_index":63,"title":{"17":{},"18":{},"19":{},"22":{},"23":{}},"description":{"7":{},"17":{},"18":{},"19":{},"20":{},"21":{},"23":{}}}],["savenam",{"_index":131,"title":{},"description":{"17":{},"18":{}}}],["script",{"_index":110,"title":{},"description":{"14":{},"22":{}}}],["server",{"_index":4,"title":{"4":{},"5":{},"8":{},"9":{},"15":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"8":{},"9":{},"10":{},"12":{},"13":{},"14":{},"15":{},"16":{},"18":{},"20":{},"21":{},"22":{},"23":{}}}],["session",{"_index":52,"title":{"12":{},"19":{},"20":{}},"description":{"5":{},"12":{},"16":{},"17":{},"19":{}}}],["sessionnam",{"_index":141,"title":{},"description":{"19":{}}}],["set",{"_index":35,"title":{"6":{},"7":{},"10":{},"11":{},"12":{}},"description":{"2":{},"6":{},"7":{},"8":{},"10":{},"11":{},"14":{},"21":{},"22":{}}}],["setup",{"_index":111,"title":{},"description":{"14":{},"22":{}}}],["shut",{"_index":108,"title":{},"description":{"14":{},"22":{}}}],["shutdown",{"_index":107,"title":{"14":{}},"description":{"14":{},"22":{}}}],["specif",{"_index":140,"title":{},"description":{"19":{}}}],["startup",{"_index":98,"title":{},"description":{"12":{}}}],["state",{"_index":42,"title":{"4":{}},"description":{"4":{},"8":{}}}],["still",{"_index":48,"title":{},"description":{"5":{}}}],["string",{"_index":89,"title":{},"description":{"10":{}}}],["succcess",{"_index":148,"title":{},"description":{"21":{}}}],["success",{"_index":72,"title":{},"description":{"8":{},"9":{},"10":{},"11":{},"12":{},"14":{},"16":{},"17":{},"18":{},"19":{},"22":{},"23":{}}}],["system",{"_index":133,"title":{},"description":{"17":{},"18":{}}}],["take",{"_index":116,"title":{},"description":{"14":{},"22":{}}}],["temporarili",{"_index":123,"title":{},"description":{"16":{},"21":{}}}],["token",{"_index":19,"title":{"1":{}},"description":{"1":{},"10":{},"11":{},"14":{},"22":{}}}],["unavail",{"_index":124,"title":{},"description":{"16":{},"21":{}}}],["updat",{"_index":76,"title":{},"description":{"8":{},"10":{},"11":{},"12":{},"14":{},"22":{}}}],["upload",{"_index":150,"title":{"22":{}},"description":{}}],["us",{"_index":38,"title":{},"description":{"3":{},"8":{}}}],["valid",{"_index":23,"title":{},"description":{"1":{},"19":{}}}],["valu",{"_index":58,"title":{},"description":{"7":{}}}],["verifi",{"_index":18,"title":{"1":{}},"description":{"1":{}}}]],"pipeline":[]}},"options":{"htmlTemplate":"./docs/index.html"}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/preview/satisfactory-api-spec.json b/preview/satisfactory-api-spec.json
index 8e91479..db0bc75 100644
--- a/preview/satisfactory-api-spec.json
+++ b/preview/satisfactory-api-spec.json
@@ -3,7 +3,7 @@
   "info": {
     "title": "Satisfactory Game Server HTTPS API specification",
     "description": "Satisfactory Game Server HTTPS API specification",
-    "version": "0.2.1-preview-11",
+    "version": "0.1.1-preview-29",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
diff --git a/preview/satisfactory-api-spec.yaml b/preview/satisfactory-api-spec.yaml
index ca3da79..6676f60 100644
--- a/preview/satisfactory-api-spec.yaml
+++ b/preview/satisfactory-api-spec.yaml
@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: Satisfactory Game Server HTTPS API specification
   description: Satisfactory Game Server HTTPS API specification
-  version: 0.2.1-preview-11
+  version: 0.1.1-preview-29
   license:
     name: MIT
     url: https://opensource.org/licenses/MIT