Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Server Settings → Install

AI-generated

Summary

Install or reinstall a server identified by the required Server UUID, optionally clearing the server directory before installation.

Inputs

  • Server UUID (required) — The unique identifier of the server to install or reinstall.
  • Query Parameters JSON — Optional JSON object containing query parameters to send with the request.
  • Body Mode — Select the format of the request body: JSON, Raw Text, or None. Defaults to JSON.
  • Truncate Directory — Boolean flag to indicate whether the server directory should be emptied before reinstalling. Only applicable when Body Mode is JSON.
  • Body JSON — Additional JSON body parameters to include with the install request when Body Mode is JSON.
  • Raw Body — Raw text to send as the request body when Body Mode is Raw Text.
  • Additional Options — Advanced request options including ignoring HTTP status errors, returning full response, and setting request timeout in milliseconds.

Output shape

a JSON object representing the server installation response or status

The response includes the server installation result as a JSON object. If 'Return Full Response' is enabled, status and headers are also returned. Errors are handled as per 'Ignore HTTP Status Errors' setting.

Links

Discussion