SatisfactoryApi

satisfactory-dedicated-server-sdk

---

Defined in: src/SatisfactoryApi.ts:29

Main API client for interacting with a Satisfactory Dedicated Server.

Provides methods to manage server options, create or load games, query server state, perform authentication, and run commands. Supports secure HTTPS communication with optional SSL certificate initialization.

Example

const api = new SatisfactoryApi("127.0.0.1", 7777, { disableSSL: false });
await api.initCertificate();
const health = await api.healthCheck();
console.log(health.success); // true if server is reachable

Constructors

Constructor

new SatisfactoryApi(host, port, options?, authToken?): SatisfactoryApi

Defined in: src/SatisfactoryApi.ts:44

Creates a new API client instance.

Parameters

host

string

The server hostname or IP address.

port

number = 7777

The server port (default 7777).

options?

SatisfactoryApiOptions

Optional configuration for the client.

authToken?

string

Optional authentication token for API access.

Returns

SatisfactoryApi

Properties

authToken?

optional authToken: string

Defined in: src/SatisfactoryApi.ts:32

---

host

host: string

Defined in: src/SatisfactoryApi.ts:30

---

options?

optional options: SatisfactoryApiOptions

Defined in: src/SatisfactoryApi.ts:33

---

port

port: number

Defined in: src/SatisfactoryApi.ts:31

Methods

applyAdvancedGameSettings()

applyAdvancedGameSettings(settings): Promise<Response>

Defined in: src/SatisfactoryApi.ts:282

Applies advanced game settings to the server.

Parameters

settings

AdvancedGameSettings

The settings to apply.

Returns

Promise<Response>

A Response confirming successful application.

Example

await api.applyAdvancedGameSettings({ GodMode: true });

---

applyServerOptions()

applyServerOptions(options): Promise<Response>

Defined in: src/SatisfactoryApi.ts:391

Applies server options.

Parameters

options

ServerOptions

Server options to apply.

Returns

Promise<Response>

A Response confirming application.

---

claimServer()

claimServer(serverName, adminPassword): Promise<Response>

Defined in: src/SatisfactoryApi.ts:302

Claims ownership of the server.

Parameters

serverName

string

Name to assign to the server.

adminPassword

string

Initial admin password.

Returns

Promise<Response>

A Response with confirmation.

---

createNewGame()

createNewGame(gameData): Promise<Response>

Defined in: src/SatisfactoryApi.ts:408

Creates a new game on the server.

Parameters

gameData

NewGameData

Configuration data for the new game.

Returns

Promise<Response>

A Response confirming creation.

---

deleteSaveFile()

deleteSaveFile(saveName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:430

Deletes a save file.

Parameters

saveName

string

Name of the save file to delete.

Returns

Promise<Response>

A Response confirming deletion.

---

deleteSaveSession()

deleteSaveSession(sessionName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:441

Deletes a save session.

Parameters

sessionName

string

Name of the session to delete.

Returns

Promise<Response>

A Response confirming deletion.

---

downloadSaveGame()

downloadSaveGame(saveName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:493

Downloads a save game from the server.

Parameters

saveName

string

Name of the save file.

Returns

Promise<Response>

A Response containing the save as an ArrayBuffer.

---

enumerateSessions()

enumerateSessions(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:451

Enumerates all save sessions on the server.

Returns

Promise<Response>

A Response containing the list of sessions.

---

getAdvancedGameSettings()

getAdvancedGameSettings(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:266

Retrieves advanced game settings from the server.

Returns

Promise<Response>

A Response containing the AdvancedGameSettings.

---

getServerOptions()

getServerOptions(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:256

Retrieves the server options.

Returns

Promise<Response>

A Response containing the current ServerOptions.

---

healthCheck()

healthCheck(clientCustomData, retries): Promise<{ data?: any; message?: string; success: boolean; }>

Defined in: src/SatisfactoryApi.ts:172

Performs a health check on the server.

Parameters

clientCustomData

string = ''

Optional client data to include in the request.

retries

number = 3

Number of retries if the health check fails (default 3).

Returns

Promise<{ data?: any; message?: string; success: boolean; }>

An object indicating success and optional server response data.

Example

const health = await api.healthCheck();
if (health.success) console.log("Server is healthy");

---

initCertificate()

initCertificate(): Promise<void>

Defined in: src/SatisfactoryApi.ts:63

Fetches and trusts the server SSL certificate on initialization.

This method must be called before making API requests if SSL verification is enabled. It saves the certificate locally and sets up the HTTPS agent.

Returns

Promise<void>

Throws

If the certificate cannot be fetched or written.

Example

await api.initCertificate();

---

loadGame()

loadGame(saveName, enableAdvancedGameSettings): Promise<Response>

Defined in: src/SatisfactoryApi.ts:463

Loads a saved game on the server.

Parameters

saveName

string

Name of the save file.

enableAdvancedGameSettings

boolean = false

Whether to apply advanced game settings (default false).

Returns

Promise<Response>

A Response confirming successful load.

---

passwordlessLogin()

passwordlessLogin(minimumPrivilegeLevel): Promise<Response>

Defined in: src/SatisfactoryApi.ts:217

Performs a passwordless login with a given minimum privilege level.

Parameters

minimumPrivilegeLevel

MinimumPrivilegeLevel

The minimum privilege required.

Returns

Promise<Response>

A Response indicating successful login and stores the token.

---

passwordLogin()

passwordLogin(minimumPrivilegeLevel, password): Promise<Response>

Defined in: src/SatisfactoryApi.ts:232

Performs a password login with a given minimum privilege level.

Parameters

minimumPrivilegeLevel

MinimumPrivilegeLevel

The minimum privilege required.

password

string

The password to authenticate with.

Returns

Promise<Response>

A Response indicating successful login and stores the token.

---

queryServerState()

queryServerState(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:246

Queries the current server state.

Returns

Promise<Response>

A Response object with detailed server state information.

---

renameServer()

renameServer(serverName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:316

Renames the server.

Parameters

serverName

string

New server name.

Returns

Promise<Response>

A Response confirming the change.

---

runCommand()

runCommand(command): Promise<Response>

Defined in: src/SatisfactoryApi.ts:364

Executes a console command on the server.

Parameters

command

string

Command string to execute.

Returns

Promise<Response>

A Response with the command output.

---

saveGame()

saveGame(saveName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:419

Saves the current game state.

Parameters

saveName

string

Name of the save file.

Returns

Promise<Response>

A Response confirming the save.

---

setAdminPassword()

setAdminPassword(password, authToken): Promise<Response>

Defined in: src/SatisfactoryApi.ts:339

Sets the administrator password.

Parameters

password

string

New admin password.

authToken

string

Admin authentication token.

Returns

Promise<Response>

A Response confirming the change.

---

setAutoLoadSessionName()

setAutoLoadSessionName(sessionName): Promise<Response>

Defined in: src/SatisfactoryApi.ts:353

Sets the session name to auto-load on server start.

Parameters

sessionName

string

Name of the session.

Returns

Promise<Response>

A Response confirming the change.

---

setClientPassword()

setClientPassword(password): Promise<Response>

Defined in: src/SatisfactoryApi.ts:327

Sets the client password for the server.

Parameters

password

string

New client password.

Returns

Promise<Response>

A Response confirming the change.

---

shutdown()

shutdown(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:374

Shuts down the server.

Returns

Promise<Response>

A Response confirming shutdown. Note: server may restart automatically depending on its service settings.

---

uploadSaveGame()

uploadSaveGame(saveName, loadSaveGame, enableAdvancedGameSettings): Promise<Response>

Defined in: src/SatisfactoryApi.ts:479

Uploads a save game to the server.

Parameters

saveName

string

Name of the save file.

loadSaveGame

boolean = false

Whether to load the game after upload (default false).

enableAdvancedGameSettings

boolean = false

Whether to apply advanced game settings (default false).

Returns

Promise<Response>

Throws

This method is not implemented yet.

---

verifyAuthenticationToken()

verifyAuthenticationToken(): Promise<Response>

Defined in: src/SatisfactoryApi.ts:206

Verifies that the stored authentication token is valid.

Returns

Promise<Response>

A Response object confirming token validity.

Throws

If the API responds with an error.