Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Admin Servers → Start Transfer

AI-generated

Summary

Starts a transfer for the specified server by sending a POST request to the Calagopus admin API. Supply the server UUID or identifier; optionally set query parameters or choose a request body mode and provide a JSON or raw text body.

Inputs

  • Server UUID (required) — Server UUID or identifier used in the request path.
  • Query Parameters JSON — Optional JSON object of query parameters; defaults to an empty object.
  • Body Mode — Select JSON, Raw Text, or None. The operation accepts a JSON body by default; JSON mode merges the Body JSON object, and Raw Text sends the provided text as the request body.
  • Body JSON — JSON object to send when Body Mode is JSON; defaults to an empty object.
  • Raw Body — Plain text request body when Body Mode is Raw Text.
  • Additional Options — Can return HTTP status and headers with the response, return error responses instead of failing on HTTP status errors, or set a timeout in milliseconds.

Output shape

A single item containing the API response body as JSON.

Arrays are wrapped in a data property, primitive responses in data, and an empty response becomes {"success":true}. Enabling Return Full Response changes the response content to include status, headers, and body. If Continue On Fail is enabled, request errors are returned in an error field.

Links

Discussion