How to Configure REST WebAPI in Terraria TShock

Note: The REST WebAPI in Terraria TShock provides a remote HTTP interface that allows administrators to query server statistics, send broadcast messages, and manage player lists from external websites or mobile apps. Enabling this service bridges your dedicated server with custom web tools.

1. Log In to Your Panel

---

2. Stop Your Server

---

3. Access the Files Tab

Select the ‘Files’ tab from the top navigation bar to open your server’s root file directory.

---

4. Open the TShock Directory

Locate and select the tshock directory from the root file listings to access your core server configurations.

---

5. Open the config.json File

Locate and select the config.json file inside your tshock directory to open the built-in configuration editor.

---

6. Locate the RestApiEnabled Setting

Locate the RestApiEnabled parameter inside the configuration file, which is disabled by default.

---

7. Configure REST WebAPI in Terraria TShock

Change RestApiEnabled from false to true, and confirm that RestApiPort is set to your allocated communication port.

"RestApiEnabled": true,
"RestApiPort": 7878,

---

8. Save File Changes

Select the ‘Save Content’ button at the bottom right corner of the editor to apply your configuration changes.

---

9. Start Your Server

---

Terraria Server Hosting

Starts at $3.99

Was this article helpful?

0 0

Please Share Your Feedback

How Can We Improve This Article?

Submit