API docs by Redocly

Satisfactory Game Server HTTPS API specification (0.2.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.

Authorizations:
None
Request Body schema: application/json
required
function
required
string
Default: "HealthCheck"

Name of the API function to execute.

Value: "HealthCheck"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Verify Authentication Token

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.

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

Name of the API function to execute.

Value: "VerifyAuthenticationToken"

Responses

Request samples

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

Response samples

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

Passwordless Login

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.

Authorizations:
None
Request Body schema: application/json
required
function
required
string
Default: "PasswordlessLogin"

Name of the API function to execute.

Value: "PasswordlessLogin"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Password Login

Attempts to log in to the Dedicated Server as a player using either Admin Password or Client Protection Password. This function requires no Authentication.

Authorizations:
None
Request Body schema: application/json
required
function
required
string
Default: "PasswordLogin"

Name of the API function to execute.

Value: "PasswordLogin"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Query Server State

Retrieves the current state of the Dedicated Server. Does not require any input parameters.

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

Name of the API function to execute.

Value: "QueryServerState"

Responses

Request samples

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

Response samples

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

Get Server Options

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.

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

Name of the API function to execute.

Value: "GetServerOptions"

Responses

Request samples

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

Response samples

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

Get Advanced Game Settings

Retrieves currently applied advanced game settings. Does not require input parameters.

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

Name of the API function to execute.

Value: "GetAdvancedGameSettings"

Responses

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.

Value: "ApplyAdvancedGameSettings"
required
object (advancedGameSettings)

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

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.

Value: "ClaimServer"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Rename Server

Renames the Dedicated Server once it has been claimed. Requires Admin privileges. Function does not return any data on success.

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

Name of the API function to execute.

Value: "RenameServer"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Set Client Password

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.

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

Name of the API function to execute.

Value: "SetClientPassword"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Set Admin Password

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.

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

Name of the API function to execute.

Value: "SetAdminPassword"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Set Auto Load Session Name

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.

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

Name of the API function to execute.

Value: "SetAutoLoadSessionName"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Run Command

Runs the given Console Command on the Dedicated Server, and returns it's output to the Console. Requires Admin privileges.

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

Name of the API function to execute.

Value: "RunCommand"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Shutdown

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.

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

Name of the API function to execute.

Value: "Shutdown"

Responses

Request samples

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

Response samples

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

Apply Server Options

Applies new Server Options to the Dedicated Server. Requires Admin privileges.

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

Name of the API function to execute.

Value: "ApplyServerOptions"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Create New Game

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.

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

Name of the API function to execute.

Value: "CreateNewGame"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

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.

Value: "SaveGame"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Delete Save File

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.

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

Name of the API function to execute.

Value: "DeleteSaveFile"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Delete Save Session

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.

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

Name of the API function to execute.

Value: "DeleteSaveSession"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Enumerate Sessions

Enumerates all save game files available on the Dedicated Server. Requires Admin privileges. Function does not require any additional parameters.

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

Name of the API function to execute.

Value: "EnumerateSessions"

Responses

Request samples

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

Response samples

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

Load Game

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.

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

Name of the API function to execute.

Value: "LoadGame"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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

Upload Save Game

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.

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required
required
object

Standard Request Data body for this request, encoded as UTF-8 JSON. Note that this includes the envelope.

saveGameFile
required
string <binary>

File attachment containing the save game file. Contents of the file will be validated on the server.

Responses

Response samples

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

Download Save Game

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.

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

Name of the API function to execute.

Value: "DownloadSaveGame"
required
object

Data to pass to the function to execute. Format of the object depends on the function being executed

Responses

Request samples

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

Response samples

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