diff --git a/preview/index.html b/preview/index.html index edaaab0..67229fb 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">

Satisfactory Game Server HTTPS API specification (0.1.1-preview-30)

Download OpenAPI specification:Download

License: MIT

Satisfactory Game Server HTTPS API specification (0.2.1-preview-1)

Download OpenAPI specification:Download

License: MIT

Satisfactory Game Server HTTPS API specification

Health Check

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.

@@ -478,7 +478,7 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Unauthorized

Request samples

Content type
application/json
{
  • "function": "GetAdvancedGameSettings"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Apply Advanced Game Settings

Request samples

Content type
application/json
{
  • "function": "GetAdvancedGameSettings"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    }
}

Apply Advanced Game Settings

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.

Authorizations:
bearerAuth
Request Body schema: application/json
required
function
required
string
Default: "ApplyAdvancedGameSettings"

Name of the API function to execute.

@@ -494,7 +494,7 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Unauthorized

Request samples

Content type
application/json
{
  • "function": "ApplyAdvancedGameSettings",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "errorData": { }
}

Claim Server

Request samples

Content type
application/json
{
  • "function": "ApplyAdvancedGameSettings",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "errorData": { }
}

Claim Server

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.

Authorizations:
bearerAuth
Request Body schema: application/json
required
function
required
string
Default: "ClaimServer"

Name of the API function to execute.

@@ -632,7 +632,7 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Unauthorized

Request samples

Content type
application/json
{
  • "function": "CreateNewGame",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "errorData": { }
}

Save Game

Request samples

Content type
application/json
{
  • "function": "CreateNewGame",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "errorData": { }
}

Save Game

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.

Authorizations:
bearerAuth
Request Body schema: application/json
required
function
required
string
Default: "SaveGame"

Name of the API function to execute.

@@ -742,7 +742,7 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">

Forbidden

Request samples

Content type
application/json
{
  • "function": "DownloadSaveGame",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errorCode": "string",
  • "errorMessage": "string",
  • "errorData": { }
}